Welcome to the Project Wiki

This is the homepage for the documentation.

Key items: - Getting started guide: Guide - Search is enabled via the search plugin. - Navigation ordering is controlled with awesome-pages using .pages.yml files.

Quick links - Home: index.md - Guide: guide/index.md - Example ordering config: .pages.yml (see example below)

---

Using awesome-pages for navigation order

awesome-pages lets you control the order and grouping of pages by placing a .pages.yml file in a directory. A .pages.yml file affects the navigation for files within its directory.

Example .pages.yml for the top-level docs directory:

```wiki/docs/.pages.yml#L1-20

Place this file at: wiki/docs/.pages.yml

This example orders the root pages and groups the 'guide' directory.

• index.md
• guide:
• index.md
• getting-started.md
• advanced.md
• reference.md
• changelog.md

  Place `.pages.yml` in a subdirectory (for example, `wiki/docs/guide/.pages.yml`) to control ordering inside that subtree.
  
  ---
  
  ## Guide (what to expect)
  
  The `guide` section contains a short getting-started guide and additional pages.
  
  Example `guide/index.md` content (create at `wiki/docs/guide/index.md`):
  
  ```wiki/docs/guide/index.md#L1-40
  # Getting Started
  
  Welcome to the guide. This section contains:
  - `getting-started.md` — quickstart and setup
  - `advanced.md` — tips, patterns, and deeper info
  
  Start with `getting-started.md` to get the project running locally.
  

---

Notes & Recommendations

• Update mkdocs.yml (found at wiki/mkdocs.yml) with your site_url and repo_url.
• Keep docs_dir set to docs (default) or adjust it if you prefer a different layout.
• Use search and awesome-pages together: search indexes the pages, awesome-pages controls nav order.
• When using Material theme features (like navigation.indexes) ensure you have the Material theme installed and the right version that supports those features.

Happy documenting!