Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature]: Improvements for the configuration package and its documentation #1864

Open
3 tasks
sdo-1A opened this issue Jun 6, 2024 · 0 comments
Open
3 tasks
Labels
documentation Improvements or additions to documentation

Comments

@sdo-1A
Copy link
Contributor

sdo-1A commented Jun 6, 2024

Context

In #1672 we mentioned the possibility of adding a linter rule and updating the documentation with the linters that we expose. The feature of the o3rWidget tag should also be mentioned in the documentation.

Proposal

  • Linter rule: The field name id should not be used in the configuration, since we use this field in our internal implementation.
  • Documentation: Mention that we expose a linter for the o3rCategories tag (docs/linter/eslint-plugin/rules/o3r-categories-tags.md)
  • Documentation: Add the feature of the o3rWidget tag (and mention that we expose a linter for it too - docs/linter/eslint-plugin/rules/o3r-widget-tags.md)
@sdo-1A sdo-1A added the enhancement New feature or request label Jun 6, 2024
@matthieu-crouzet matthieu-crouzet added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Jun 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants