microsoft/openvmm

Public

66281e05801fe40f17d18b3f14790effde4e8c04

Find a branch or tag

HTTPS

.github/instructions/guide-docs.instructions.md

33lines · modecode

unknown

1	`---`
2	`applyTo: "Guide/**"`
3	`---`
4
5	`# Guide Documentation Style`
6
7	Follow the style guide at `Guide/src/dev_guide/contrib/style_guide.md`.
8
9	`## Authoring Rules`
10
11	`- Use mdbook-admonish syntax for callouts:`
12	`` ```admonish note ``, `` ```admonish warning ``, `` ```admonish tip ``
13	— do NOT use docfx `> [!NOTE]` syntax
14	- Label all code fences with the language (`bash`, `powershell`, `rust`, etc.)
15	`- Keep code blocks under 30 lines; split with explanatory text`
16	`- Wrap lines at 80 characters`
17	- Use `path/to/...` placeholders for file paths, or
18	`<SCREAMING_SNAKE_CASE>` for non-obvious values (VM names, build numbers)
19
20	`## Content Policy`
21
22	`- This is an OSS repo — do not reference internal Microsoft tools, wikis,`
23	`build paths, or infrastructure`
24	`- Link to crate rustdoc where possible (https://openvmm.dev/rustdoc/)`
25	`- When referencing code, use backtick crate names or relative paths from`
26	`the repo root`
27
28	`## Structure`
29
30	- Every new page must be added to `Guide/src/SUMMARY.md`
31	`- Use the existing hierarchy: user_guide → dev_guide → reference`
32	- Reference pages live under `reference/` organized by component type
33	`(emulated, vmbus, backends, architecture)`
34