The source for https://docs.safedep.io
To start a local environment of this project docs, please do the following
- Clone the repository
git clone https://github.com/safedep/docs.safedep.io.git- Navigate to the guide directory
cd docs.safedep.io- Install dependencies
npm install- Start the development server
npm start- Navigate to http://localhost:3000 for accessing the docs.
We will align with the diataxis documentation style, however, make the necessary deviation to fit our needs. To summarize the framework
| Type | Description |
|---|---|
| Tutorial | A tutorial is an experience that takes place under the guidance of a tutor. A tutorial is always learning-oriented. |
| How-to Guides | How-to guides are directions that guide the reader through a problem or towards a result. How-to guides are goal-oriented. |
| Reference | Reference guides are technical descriptions of the machinery and how to operate it. Reference material is information-oriented. |
| Explanation | Explanation is a discusive treatment of a subject, that permits reflection. Explanation is understanding-oriented. |
General guidance
- Use the
markdownfile format for the documentation - All top level documentations are essentially
tutorials, as they help in high level learning. Keep them short, specific and focus on great developer experience - All detailed documentation with specific goals should go into
guidesfolder - All API related documentation should go into
apifolder
We are essentially writing tutorials and how-to guides as part of this documentation. When the need arises, we will create separate sections for explanations (concepts) and references to serve as details.