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

Provide an index/navigation README.md for user md documentation. #5147

Open
brtnfld opened this issue Nov 25, 2024 · 1 comment
Open

Provide an index/navigation README.md for user md documentation. #5147

brtnfld opened this issue Nov 25, 2024 · 1 comment
Assignees
@byrnHDF
Labels
Component - Documentation Doxygen, markdown, etc. Priority - 3. Low 🔽 Code cleanup, small feature change requests, etc. Type - Improvement Improvements that don't add a new feature or functionality

Comments

@brtnfld
Copy link
Contributor

brtnfld commented Nov 25, 2024

If a directory containing .md files serves as user documentation (such as the "doc" directory), it should include an index or navigation .md file. This file should describe the contents of each file and include a link to each one.
@brtnfld brtnfld added the Component - Documentation Doxygen, markdown, etc. label Nov 25, 2024
@glennsong09 glennsong09 added Priority - 3. Low 🔽 Code cleanup, small feature change requests, etc. Type - Improvement Improvements that don't add a new feature or functionality labels Nov 26, 2024
@glennsong09
Copy link
Contributor

Investigate where files in hdf5/doc and plugin repos are still needed. Maybe should live in doxygen?

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

@byrnHDF byrnHDF

Labels
Component - Documentation Doxygen, markdown, etc. Priority - 3. Low 🔽 Code cleanup, small feature change requests, etc. Type - Improvement Improvements that don't add a new feature or functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@brtnfld @glennsong09 @byrnHDF