How to use this Handbook
Archipelo is a remote company, thus we follow the document-first approach.
This page is a collection of internal documents describing how we work. Each page is a file rendered from the handbook directory of our Archipelo/top repository.
How to edit
To edit the documents or add new ones, you can use "Edit this page" links at the bottom of each page, or just do the changes directly in the repository and commit them.
If you're unsure what type of document do you want to create and which tool should be used, take a look at the Documentation Explained article.
The docs are checked with the markdownlint pre-commit hook and must comply with the rules configured in the .markdownlint.yaml file at the root of the repository.
More Docusaurus guides
The Handbook is generated with Docusaurus from the Markdown files. Full documentation of Docusaurus can be found here, while Markdown Syntax is available here (or extended syntax called MDX).
- Markdown and MDX features
- How to create a document
- How to create a page
- Modify your site configuration with
docusaurus.config.js - Add navbar and footer items with
themeConfig - Add a custom Design and Layout
- Find inspirations in the Docusaurus showcase