Skip to content

[πŸ“š Documentation Issue]: implement new documentation structureΒ #700

@egarciamendez

Description

@egarciamendez

Preliminary Checks

  • I have read the relevant section of the documentation.
  • I have searched the issue tracker for similar documentation issues.

Documentation Section

.
β”œβ”€β”€ Home
β”œβ”€β”€ Getting Started/
β”‚ β”œβ”€β”€ Installation
β”‚ β”œβ”€β”€ Quick start
β”‚ β”œβ”€β”€ Changelog/
β”‚ β”‚ └── How to upgrade
β”‚ └── ...
β”œβ”€β”€ Guides/
β”‚ β”œβ”€β”€ Concepts/
β”‚ β”‚ β”œβ”€β”€ Structure (document about the fact we are organizing by document)
β”‚ β”‚ β”œβ”€β”€ Formulas (Explanation of what the formula object is and how it is designed)
β”‚ β”‚ └── Code Standards (objects overview)
β”‚ β”œβ”€β”€ Examples/
β”‚ β”‚ └── ...
β”‚ └── Contributing
└── API Reference

Inspired by https://squidfunk.github.io/mkdocs-material/

Image

Issue Description

Let's make the docs a place worth visiting!

Confirmation

  • I have checked that this issue does not already exist in the issue tracker.
  • I have read and understood the contribution guidelines.

Sub-issues

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions