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/wiki #26

Open
AgentRBY opened this issue Nov 10, 2022 · 2 comments
Open

Add docs/wiki #26

AgentRBY opened this issue Nov 10, 2022 · 2 comments

Comments

@AgentRBY
Copy link

Add documentation or a wiki page on GitHub so the community can do documentation!

I could try to describe the basic stuff.

@zardoy
Copy link
Owner

zardoy commented Nov 11, 2022

I was thinking of creating a website within repository for a long time. But probably wiki is fine for the first time (we can then move contents to the website at any time). I've created a wiki page, so you can try to add any content you like. Feel free to experiment, I'll look into it!

Another thing that I don't really like about wikis is that they are too unrestrictive (everyone can edit them without a notice).

@AgentRBY
Copy link
Author

AgentRBY commented Nov 11, 2022

In theory, you can create a documentation site using Vitepress or other similar tools, and deploy to Github Pages.

But thanks for the wiki

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

2 participants