Skip to main content

Sidebar Ordering

How Docusaurus decides the order of items in the left sidebar. Lower number = higher up. Two mechanisms, depending on whether the item is a folder or a standalone doc.

The two knobsโ€‹

Item typeWhere the number livesField
A folder (category)_category_.json in that folderposition
A standalone docthe doc's frontmattersidebar_position

Each folder is its own list. Items only compete for a number when they share the same parent โ€” so position: 5 in two different folders is fine, but two siblings both at 5 will clash and order unpredictably.

Category folder โ€” _category_.jsonโ€‹

{
"label": "๐Ÿ›  Tooling",
"position": 3,
"link": {
"type": "generated-index",
"description": "Developer tooling notes โ€” setup, configuration, and workflow tips."
}
}
  • link.type: "generated-index" โ€” auto-builds a landing page listing the folder's docs. This is the usual choice for a category.
  • link.type: "doc" โ€” instead points the category link at one specific document (by its doc ID). Use when you have a hand-written intro page for the section.

Standalone doc โ€” frontmatterโ€‹

---
title: Start Here
sidebar_position: 1
---

sidebar_position: 0 pins a doc to the very top of its group (lowest number wins) โ€” handy for an intro/landing doc.

Full ordering mapโ€‹

Legend: DIR = category folder (position in _category_.json), doc = standalone page (sidebar_position in frontmatter), โ€“ = no position set (falls back to alphabetical).

Top level โ€” docs/โ€‹

poskinditem
1docintro.md
2DIR๐Ÿค– AI Engineering
3DIR๐Ÿ›  Tooling
4DIR๐Ÿš€ Projects
5DIR๐ŸŽ“ Courses
6DIR๐Ÿข EDB
7DIR๐Ÿ—„๏ธ Databases

Non-AI topic categories (Databases, and later Backend, Frontend, Languages, โ€ฆ) are added under docs/ as their first note arrives โ€” see FILING-NOTES.md.

๐Ÿค– AI Engineering โ€” docs/ai/โ€‹

poskinditem
1docstart-here.md
2DIR๐Ÿ“š Knowledge Bank (knowledge-bank/)
3DIR๐Ÿงช Learnings (learnings/)
4docglossary.md
5docbuilding-an-agentic-system.md
6docai-first-methodology.md
7docreading-list.md
8docopen-questions.md
9docASSISTANT_PROMPT.md

Inside knowledge-bank/ (category links to the overview doc):

poskinditem
0doc00-overview.md
1doc01-foundations.md
2doc02-intermediate.md
3doc03-expert.md

Inside learnings/ โ€” one flat folder, one file per learning (overview.md pinned at sidebar_position: 0, the rest alphabetical). No sub-folders.

๐Ÿ›  Tooling โ€” docs/tooling/โ€‹

poskinditem
1docsidebar-ordering.md
โ€“DIRdevcontainers/

devcontainers/ has no position, so it sorts after positioned items by name.

๐Ÿš€ Projects โ€” docs/projects/โ€‹

poskinditem
1DIRShortcut AI Agent (shortcut-ai-agent/)

๐ŸŽ“ Courses โ€” docs/courses/โ€‹

poskinditem
1DIRGoogle ร— Kaggle GenAI (google-kaggle-genai/)

Inside google-kaggle-genai/:

poskinditem
0docindex.md (pinned to top)
1docagents.md

๐Ÿข EDB โ€” docs/edb/โ€‹

poskinditem
1docstart-here.md
2docglossary.md
3DIRSystems & Applications (systems/)
4DIRDomain & Business (domain/)
5DIRFlows & Processes (flows/)
6DIRData Patch Agent (data-patch-agent/)

Inside EDB subfolders (each has a single note for now):

folderposdoc
systems/โ€”(no docs yet)
domain/1cost-categories.md
flows/1subform-gctemplate.md
data-patch-agent/โ€“notes.md

Gotchasโ€‹

  • Same-level collisions are the usual bug: two siblings on the same number. Keep siblings on a clean 1, 2, 3, โ€ฆ sequence.
  • Positions don't need to be unique across different folders โ€” only within a single parent.
  • If nothing sets a position, Docusaurus falls back to alphabetical order.