Giter Site home page Giter Site logo

Validations "QOR Support" section about doc HOT 7 OPEN

qor avatar qor commented on July 21, 2024
Validations "QOR Support" section

from doc.

Comments (7)

raven-chen avatar raven-chen commented on July 21, 2024

Removed unnecessary QOR support text.

from doc.

coreform avatar coreform commented on July 21, 2024

Those are remnants of the per-repo README documentation. For the new monolithic Doc, I have been changing that section to 'QOR Integration', removing the basic QOR introduction paragraph and replacing with something like:

Although Location could be used alone, it integrates nicely with QOR.

E.g.:
https://github.com/qor/doc/blob/master/plugins/i18n.md
https://github.com/qor/doc/blob/master/plugins/l10n.md

adccebf
^ shows some work to improve that section. It is not redundant as it makes it clear that such Plugins can be used standalone. Ideally, we would be achieving clarity and consistency, rather than just consistency as a result of this Issue.

from doc.

coreform avatar coreform commented on July 21, 2024

Reopening as it would be ideal to follow the new pattern for QOR Integration sections (consistency) in applicable Plugins.

from doc.

bodhi avatar bodhi commented on July 21, 2024

Although Location could be used alone, it integrates nicely with QOR

This seems odd: this is the QOR doc, and Location is being described as a QOR plugin, so it would be strange if it didn't integrate nicely?

from doc.

raven-chen avatar raven-chen commented on July 21, 2024

Yeah. Better to separate it into two sections. "Integrate with QOR" and "Use it alone". Let's just focus on the first section for now ?

from doc.

coreform avatar coreform commented on July 21, 2024

It would be nice if there were more information about how each Plugin integrates with QOR (because that is effectively what QOR is: an integration of components and Plugins). Like the information provided in https://github.com/qor/doc/blob/master/plugins/activity.md , that would give developers a better understanding of what to expect to see and the behaviour in QOR Admin when a Plugin is used.

from doc.

raven-chen avatar raven-chen commented on July 21, 2024

@coreform yes. https://doc.getqor.com/helpers/render.html this is a good negative example. I'm working on it now.

from doc.

Related Issues (12)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.