https://github.com/zefhub/zef-docs
https://github.com/zefhub/zef-docs
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zefhub/zef-docs
- Owner: zefhub
- Created: 2020-12-08T09:46:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-13T05:07:04.000Z (over 3 years ago)
- Last Synced: 2025-12-29T12:25:04.859Z (6 months ago)
- Language: Jupyter Notebook
- Homepage: https://zef-docs.vercel.app
- Size: 27 MB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ZefDB Docs
[This approach and talk](https://documentation.divio.com/) largely influenced the structure of this documentation.
Below is a proposal for how the ZefDB docs can be organized:
- Quickstart: step-by-step instructions to help new users get ZefDB (and ZefHub) up and running
- Tutorials: bite-sized end-to-end projects to help users learn new ways of using ZefDB
- How-to: step-by-step instructions answering a specific question or solving a common problem
- Reference: descriptions of each individual ZefDB "user tool" without any extended explanations or justifications
- Discussions: additional links for bug reporting and feature roadmaping
The above is designed for if/when ZefDB is full-fledged open source.
The current iteration of documents is designed for the very earliest private alpha test users, assuming they go through a guided demo and environment setup.
## Getting started
- Install Docusaurus:
```console
yarn install
```
- Build the website for development:
```console
yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
- Build the website for deployment:
```console
yarn build
```
Pushing to the `master` branch triggers a GitHub action which executes `yarn build` and deploys the updated website to `docs.zefdb.com`. `build` performs additional consistency checks compared to `start`, hence it is a good idea to run `yarn build` locally before pushing.