search

appy-one / acebase

A fast, low memory, transactional, index & query enabled NoSQL database engine and server for node.js and browser with realtime data change notifications
MIT License
481 stars 27 forks source link

Create new documentation site based on README #232

Closed etekweb closed 1 year ago

etekweb commented 1 year ago

Adds a new documentation site based on the current README.md file. This approach is much easier to navigate than the current docs since you can use the navigation bar on the left-hand side (as discussed in #95).

Note To publish the documentation, a project maintainer will need to set up GitHub Pages to point to the docs/ folder in the repo. See here for instructions.

Future Development

After the documentation site is published, the main repo README.md file can then be dramatically simplified to just contain the basic project info and a link to the documentation site.

Also, it would probably be useful to ultimately divide the README file into multiple subpages. This will reduce the overall amount of information on first load, as well as simplifying future updates to the documentation.

appy-one commented 1 year ago

Awesome @etekweb I'll take a look!

appy-one commented 1 year ago

The docs are now live at https://appy-one.github.io/acebase/ Thanks for your contribution @etekweb!