Documentation

Documentation

Explore the public documentation of BlackTrails – philosophy, principles, and technical guides.

Welcome to the BlackTrails Documentation

Here you will find everything you need to understand and work with BlackTrails:
our philosophy, the core principles that guide the community, and the logic behind our technical ecosystem.

The documentation is organized in sections, each represented by a folder under content/docs/.
Each section has its own meta.json, which defines its title, order in the sidebar, and the list of .mdx files included.
Every .mdx file has frontmatter (title, description) that controls how it appears in the navigation.

This way, documentation is:

  • Modular → add or remove sections without breaking structure.
  • Localized → each .mdx can have .it.mdx, .en.mdx, etc.
  • Consistent → sidebar and routing are generated automatically from the content.

Documentation structure

The public docs are divided into sections such as:

  • Getting Started → orientation, how to begin, technical basics.
  • Vision → the 10 Core Principles and our philosophical foundation.
  • Future sections → dedicated to features, roadmap, and integrations.

Each section lives inside its own folder, for example:

content/docs/
  meta.json            # root index
  index.mdx            # landing page (this file)
  getting-started/
    meta.json
    overview.mdx
  vision/
    meta.json
    core-principle.mdx

Code example

Below is a simple Python example, shown here to illustrate code highlighting within documentation pages:

def hello_blacktrails():
    print("Welcome to BlackTrails Documentation!")

Images

Documentation pages support images with zoom and responsive rendering.
For example, the image below demonstrates the BlackTrails documentation layout:

BlackTrails Documentation


Lists

This is an example of how lists are rendered:

  • Clear and modular organization
  • Multi-language support (IT/EN/…)
  • Automatic sidebar generation

Philosophy behind the docs

At BlackTrails, documentation is not just a manual: it is part of our transparency and our community approach.

By opening our principles, our logic of development, and our code organization, we make the project accessible and auditable to all.

Documentation is both:

  • A technical reference for those building with us,
  • A philosophical guide for those who want to understand the vision that sustains BlackTrails.
Documentation | Documentation | In-1 Chat