IFT Docs Standards repo layout

[jorge-campo]

Discussed in #12

^{Originally posted by jorge-campo July 7, 2025}
As we develop the various document type templates and examples, we must also create the IFT Docs Standards in parallel. These standards expand on the templates information and provide answers to the most common questions.

Sections

The Docs Standards will be structured in sections:

1. General guidelines: A short introduction on the aim and general rules to use in IFT Docs.
2. Structure the content: A description of the different document types, how to use them, and how to structure them on the left-hand side navigation.
3. Style the content: A detailed description of how to style the written parts of the document (paragraphs, lists, tables, etc.)
4. Work with media: Guidelines to work with the non-written parts of the document (icons, screenshots, diagrams, etc.)
5. Terminology: A list of the accepted and non-accepted terms to use when writing a document (for example, "dapp" vs. "dApp")

Layout

This represents the folders and files layout in the status-im\ift-docs repository

docs/
├── 00-general-guidelines.md                    # “General guidelines”
│
├── 10-structure-the-content/                   # “Structure the content”
│   ├── _index.md
│   ├── 01-document-types/
│   │   ├── concept.md
│   │   ├── task.md
│   │   ├── reference.md
│   │   └── tutorial.md
│   ├── 02-navigation.md
│   └── 03-examples.md
│
├── 20-style-your-content/                      # “Style your content” (see note)
│   ├── _index.md
│   ├── 01-paragraphs.md
│   ├── 02-lists.md
│   ├── 03-tables.md
│   └── 04-callouts.md
│
├── 30-work-with-media/                         # “Work with media”
│   ├── _index.md
│   ├── 01-icons.md
│   ├── 02-screenshots.md
│   ├── 03-diagrams.md
│   └── 04-videos.md
│
└── 40-terminology/                             # “Terminology”
    ├── _index.md
    ├── waku.md
    ├── codex.md
    └── example-project.md

And this is the corresponding Mermaid diagram:

mindmap
  root((docs))
    00-general-guidelines.md
    10-structure-the-content
      01-document-types
        concept.md
        task.md
        reference.md
        tutorial.md
      02-navigation.md
    20-style-your-content
      paragraphs.md
      lists.md
      tables.md
    30-work-with-media
      icons.md
      screenshots.md
    40-terminology
      waku.md
      codex.md

Loading

@cheny0