✍️ Writing

MkDocs Nav Map from mkdocs.yml Inventory (No Invented Word Counts)

Turn an MkDocs mkdocs.yml inventory into a nav map only. No invented word counts, build times, or pageview totals beyond the inventory.

0.0
0Reviews
P
September 10, 2026

Prompt

Act as an MkDocs documentation engineer who only uses a pasted mkdocs.yml inventory. You write a nav map the inventory already supports. You do not invent word counts, build times, pageview totals, or search index sizes. This is not a live MkDocs build and not a SEO audit.
You work only from Inputs. Do not invent stats, citations, quotes, URLs, names, IDs, or records that are not in Inputs.

Inputs:
- mkdocs.yml inventory I lock (nav stubs, page cues, plugin notes): [Inventory]
- MkDocs / theme version notes I lock: [Version]
- Site or project label I may quote (or UNKNOWN): [Workspace]
- Required nav or page names I may quote (or UNKNOWN): [SpecNames]
- Words I must not use: [Banned]
- What I must never invent (word counts, build times, pageview totals, search index sizes): [Never]
- Output format: [Format]
- Language: [Lang]

Generate:
1. Honesty ledger: Inventory nouns, Version, Workspace, SpecNames, Lang. Forbidden: invented word counts, build times, pageview totals, search index sizes. Banner: not a live MkDocs build; not a SEO audit.
2. Nav map table: one row per Inventory nav stub or page cue. Missing plugin notes write NOT IN INPUTS. Use MkDocs nav, Material theme, plugins, and markdown_extensions language when Inventory supports it.
3. Spec name set: only names in SpecNames. Unnamed pages stay NOT IN INPUTS. Never print word-count or build-time VALUES not in Inventory.
4. Version lock: print Version. Refuse MkDocs features newer than Version if Version is named.
5. Refuse list: inventing word counts, inventing build times, inventing pageview totals, inventing search index sizes.
6. Compliance pass: quote Banned and Never hits. Cut them. Format as Format.

Constraints:
- Map from Inventory only. No invented word-count VALUES. Teach MkDocs nav mapping, not a generic docs-site swap.
- Honor Version. No emojis.

Instructions

Replace every [bracket] with your details before running. Works on ChatGPT, Claude, and Gemini.

Generated Output

This image was generated using the prompt above.

MkDocs Nav Map from mkdocs.yml Inventory (No Invented Word Counts) - Result

Examples

Example Input

Inventory: nav Harbor Quay Berth Guide as pasted page cue berth/index.md as pasted plugin note search as pasted; nav River Ops Gate Runbook as pasted page cue gate/runbook.md as pasted. Word count NOT IN INPUTS. Build time NONE.
Version: MkDocs 1.6 Material 9 as pasted (do not invent unreleased AI chat plugins)
Workspace: Harbor Quay Docs Site as pasted
SpecNames: Berth Guide as pasted; Gate Runbook as pasted. Tide FAQ UNKNOWN.
Banned: guaranteed word count, build invent, pageview invent, index invent
Never: invent word counts, invent build times, invent pageview totals, invent search index sizes
Format: ledger + table + specs + version + refuse + compliance
Lang: English

Example Output

1. Ledger. Inventory: nav Harbor Quay Berth Guide page cue berth/index.md plugin note search; nav River Ops Gate Runbook page cue gate/runbook.md. Word count NOT IN INPUTS. Build time NONE. Version MkDocs 1.6 Material 9. Workspace Harbor Quay Docs Site. SpecNames Berth Guide; Gate Runbook; Tide FAQ UNKNOWN. Lang English. Banner: not a live MkDocs build; not a SEO audit. Forbidden: invented word counts, build times, pageview totals, search index sizes, guaranteed word count, build invent, pageview invent, index invent.

2. Nav map.
1. Harbor Quay Berth Guide | page berth/index.md as pasted | plugin search as pasted | word count NOT IN INPUTS | build time NONE | MkDocs nav map only.
2. River Ops Gate Runbook | page gate/runbook.md as pasted | plugin NOT IN INPUTS | word count NOT IN INPUTS | build time NONE.
Pageview totals not printed. Search index sizes not invented.

3. Spec name set. Berth Guide; Gate Runbook as SpecNames. Tide FAQ UNKNOWN so write Tide FAQ NOT IN INPUTS. No word-count VALUES printed. No third nav invented.

4. Version lock. MkDocs 1.6 Material 9 as pasted. Unreleased AI chat plugins not used. mkdocs.yml schema extras NOT IN INPUTS.

5. Refuse. Word-count invent: refused. Build invent: refused. Pageview invent: refused. Index invent: refused. Guaranteed word count: refused.

6. Compliance. Banned hits none. Format ledger+table+specs+version+refuse+compliance. Gaps: plugin for River Ops Gate Runbook, Tide FAQ decision, section nesting, edit_uri, social cards if any.

Missing-data policy: if a field was blank, write NOT IN INPUTS rather than guessing. Lock any tool version named in Inputs; if unnamed, write unknown. No invented testimonials, star ratings, or press logos. If legal, clinical, insurance, HR, education-plan, or veterinary content appears, add a one-line not-advice and de-identify banner. Quote banned-word hits and cut them. End with a gaps list of five bullets the user still owes you. Character and byte caps in the job are hard; print counts when relevant. Refuse to backfill DOIs, exam dumps, PHI, PII, or compensation promises not in Inputs.

Reviews (0)

Please login to leave a review.
Loading reviews...