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

Update usage documentation and use cases #525

Open
bigboss2063 opened this issue Dec 6, 2023 · 2 comments
Open

Update usage documentation and use cases #525

bigboss2063 opened this issue Dec 6, 2023 · 2 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@bigboss2063
Copy link
Member

Since the way nutsdb is used has changed, some documents and use cases have not been updated and need to be updated now.

@bigboss2063 bigboss2063 added help wanted Extra attention is needed good first issue Good for newcomers labels Dec 6, 2023
@TremblingV5
Copy link
Contributor

I see that there's a repo named nutsdb-docs in the repos list of NutsDB. So I think it can be more useful.

In this repo I found some documents but them seem old. I think we can reuse this repo to publish documents for NutsDB. I'm not quite sure what framework was used in the existing nutsdb-docs. Maybe we can perfect it or use some other framework like https://github.com/facebook/docusaurus . docusaurus has rich document functions and good supports for multiple versions, multiple languages, and also can publish blogs.

Totally, I think use a github page to present more rich documents will be better for promoting NutsDB.

@xujiajun
Copy link
Member

@TremblingV5 Indeed, this project has not been maintained for a long time, resulting in a lot of information being out of date. Currently, it is all markdown files. It seems that the static page is generated using https://jekyllrb.com/. I think your suggestion is very good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants