README

MyOS-Simple Wiki

A local, in-repository documentation wiki for MyOS-Simple, the five-stage bare-metal x86 OS tutorial. Start at Home.md for the full catalog and reading paths.

Every page is verified against the source in this repository and cites it as path:line. There are 31 articles in four sections plus this index.

Layout

wiki/
├── Home.md                 Landing page + complete catalog
├── _Sidebar.md             Navigation (rendered as the sidebar on GitHub Wikis)
├── README.md               This file
├── concepts/               One idea per page — the theory behind the stages (15)
├── stages/                 Guided walkthrough of each of the five stages (5)
├── reference/              Dense lookups: memory map, ports, GDT bits, scancodes,
│                           commands, toolchain, glossary (7)
└── guides/                 How-to: build, debug, troubleshoot, extend (4)

Reading paths

• The tour. Stage 1 → 2 → 3 → 4 → 5, following links into the concepts as questions arise.
• The deep dive. Read the concepts in catalog order from Home.md.
• The cheat sheet. Keep reference/ open while you hack.

Using it as a GitHub Wiki

The files use GitHub-Wiki conventions: Home.md is the landing page and _Sidebar.md renders as the navigation sidebar. The links here are relative (../section/page.md) so the folder browses cleanly in the repository.

GitHub Wikis flatten every page to the top level and do not rewrite links inside subfolder pages, so those ../ links must be flattened to bare basenames before publishing. The scripts/sync-wiki.sh helper does this automatically — it clones the wiki repo, copies this folder in, flattens the links, and pushes:

scripts/sync-wiki.sh                 # publish to the GitHub Wiki
scripts/sync-wiki.sh --dry-run       # preview changes without pushing

Conventions

• # Title + a one-line italic tagline open every page.
• Knowledge nuggets appear as > 💡 **Tidbit:** and limitations as > ⚠️ **Caveat:**.
• Code is quoted from the real source with path:line citations.
• Each page ends with a cross-linked See also section.