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

Documentation website #293

Open
calavera opened this issue Mar 22, 2024 · 2 comments
Open

Documentation website #293

calavera opened this issue Mar 22, 2024 · 2 comments
Assignees

Comments

@calavera
Copy link
Contributor

As this project grows, we need a better place to put the different documentation than the README.md file.

I'd like to recommend we use GitHub Pages with a documentation oriented framework like https://docusaurus.io/ to create a documentation website. This would allow us to organize resources better than we can now in the README.md, and expand user and contributor topics beyond what we currently have.

If the maintainers are ok with this idea, I can take a pass at setting it up.

@bnusunny
Copy link

That'll be great! We could probably also try using AI Agents to help with documentation.

@richarddavison
Copy link
Contributor

richarddavison commented Mar 25, 2024

There is already work being done by @Azchau. He has a basic website built using Material for MkDocs. PR coming up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants