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

Add docs/ materials to documentation website (docsite) #76

Open
d33bs opened this issue Jan 22, 2025 · 0 comments
Open

Add docs/ materials to documentation website (docsite) #76

d33bs opened this issue Jan 22, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@d33bs
Copy link
Collaborator

d33bs commented Jan 22, 2025

I noticed we have some nice docs within the primary readme and under the docs/ directory. It might be nice for the package audience to consume this information through a documentation website (docsite) such as that which is produced by sphinx or mkdocs. Given that this project is part of a larger family under manubot I wasn't sure if that meant the content should remain isolated here or if it would be better to add it to "organizational" docs for the manubot project.

Benefits here would be that the content might be more easily found and read by people wanting to make use of the project. It also might be beneficial in terms of external SEO (if someone searches using Google, etc.) to help make the docs more easily findable when someone searches outside of GitHub.

@d33bs d33bs added the documentation Improvements or additions to documentation label Jan 22, 2025
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

1 participant