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

Consider something like readthedocs or wiki for documentation #338

Open
dvenprasad opened this issue Apr 24, 2023 · 1 comment
Open

Consider something like readthedocs or wiki for documentation #338

dvenprasad opened this issue Apr 24, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@dvenprasad
Copy link
Member

As we have added more modules( and plan to add more), it is difficult to discover and navigate the additional modules with the current format. The docs would benefit from having a navigational menu.

The current structure also makes it difficult for us to convey the full breadth of features of this pipeline.

We should consider using Read the Docs or maybe even the Wiki.

@dvenprasad dvenprasad added the documentation Improvements or additions to documentation label Apr 24, 2023
@jaclyn-taroni
Copy link
Member

We might find this reference helpful if we go the GitHub Wiki route: https://nimblehq.co/blog/create-github-wiki-pull-request

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