nodefony-documentation

Write, validate, and publish Nodefony documentation with lint gates and site generation.

Updated Dec 19, 2023
One-click install
npx skills add https://github.com/nodefony/nodefony-core --skill nodefony-documentation-nodefony
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: nodefony-documentation
Source: https://github.com/nodefony/nodefony-core/tree/main/.claude/skills/nodefony-documentation
Command: npx skills add https://github.com/nodefony/nodefony-core --skill nodefony-documentation-nodefony

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve? Maintaining accurate Nodefony documentation is hard: code anchors drift out of date, internal links break silently, quick-start examples stop compiling, and publishing to GitHub Pages risks dead links. This Skill provides the complete toolkit to write, verify, and publish the Nodefony documentation corpus across its three consumers: the public site, the admin console portal, and the writing standard itself. ## Core Features & Use Cases - Documentation quality gates: Run doc-lint, anchor-check, anchor-inpage, and code-check scripts to enforce frontmatter conventions, verify file:line code anchors against real source, detect dead in-page anchors, and compile quick-start TypeScript blocks. - Anchor repair: Automatically recalibrate stale code anchors after code changes using anchor-fix, which resolves symbols to their definition lines with dry-run and apply modes. - Public site publishing: Generate the GitHub Pages site with build-docs-site.mjs, decide page visibility via folder, status, and the publish frontmatter key, and enforce relative-link rules with the anti-dead-link gate. - Portal front-end components: Build documentation pages in the Studio admin console using DocLayout, MarkdownDoc, DocPageHeader, DocToc, and FlowGraph with a strict zero-magic-number layout model. - Use Case: After refactoring a Nodefony module, run anchor-check piped into anchor-fix to recalibrate every documentation anchor that referenced moved code, then re-verify with the four gates before committing. ## Quick Start Ask the assistant to write a new documentation page for a Nodefony module and run the doc-lint, anchor-check, anchor-inpage, and code-check gates on it before committing.

Frequently Asked Questions about nodefony-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new documentation page to the Nodefony portal?

Write the Markdown file with the required frontmatter (title, topic, audience, version, status) inside the module's docs/ folder, following the writing standard. The page is then served by the documentation module's API and rendered in the portal with DocLayout and MarkdownDoc.

How do I fix outdated file:line code anchors in documentation?

Run anchor-check.mjs on the page to list SUSPECT anchors, pipe its output into anchor-fix.mjs for a dry run, then rerun with --apply to recalibrate each anchor to the symbol's definition line. Finish with another anchor-check pass to confirm zero suspects.

What decides whether a documentation page is published to the public site?

Publication is decided by folder, by page status, and finally by the publish key in the page's frontmatter. The build-docs-site.mjs generator lists what it excludes along with the reason, and only relative links are allowed on the published site.

Does the documentation linter check code examples compile?

Yes, code-check.mjs extracts TypeScript blocks from the Quick Start section and compiles them with tsgo under strict mode against the real workspace packages. Blocks flagged with ignore or no-check are skipped, everything else must compile.

Why do internal page anchors break in the documentation portal?

In-page anchors break when the slug rule in anchor-inpage.mjs diverges from slugifyHeading in the DocToc component, since both must produce identical GitHub-style slugs. Changing one without the other silently kills table-of-contents links.

When should I use a different skill instead of the documentation skill?

Use nodefony-studio-dev for generic Studio screens, nodefony-create-module to scaffold a new back module, and nodefony-framework-dev for non-documentation back-end services. This skill covers doc pages, the portal, the public site, and the writing standard.