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.

Sign up for GitHub

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

Jump to bottom

📚 [Documentation]: Improve descriptions of all components (including those that are/were in config/) #400

Open
mishaschwartz opened this issue Nov 9, 2023 · 2 comments
Open

📚 [Documentation]: Improve descriptions of all components (including those that are/were in config/) #400

mishaschwartz opened this issue Nov 9, 2023 · 2 comments
Assignees
@mishaschwartz @tlvu
Labels
documentation Improvements or additions to documentation

Comments

@mishaschwartz
Copy link
Collaborator

Description

After the migration of the components in the config/ directory to the components/ directory, we should add descriptions of all new and existing components in the components/ directory to components/README.rst.

First discussed here: #399 (comment)
Requires that #399 be pulled in first (or can be included in #399) if necessary.

References

Information Value
Server/Platform URL
Related issues/PR
Related documentation
@mishaschwartz mishaschwartz added the documentation Improvements or additions to documentation label Nov 9, 2023
@mishaschwartz mishaschwartz mentioned this issue Nov 9, 2023
Merged
@mishaschwartz mishaschwartz changed the title 📚 [Documentation]: Add descriptions of all components (including those that are/were in config/) 📚 [Documentation]: Improve descriptions of all components (including those that are/were in config/) Dec 8, 2023
@mishaschwartz
Copy link
Collaborator Author

Very basic descriptions were added in #399 but we should improve on them at a later date.

@mishaschwartz
Copy link
Collaborator Author

Suggestion from: #399 (comment)

Future updates should probably reorganize them slightly so they are sorted similarly to the components directory.
A TOC would also be useful since there are quite a lot in there now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mishaschwartz mishaschwartz

@tlvu tlvu

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mishaschwartz @tlvu