skills.rest
flet-dev
flet-devOFFICIAL
Explore all skills by this author →
Website𝕏@fletdevGitHub

docs-build-and-verify

Builds the Flet documentation website and detects broken links, images, and cross-references.

16.6k|685|Updated Mar 24, 2022
Search Tags:#verification#broken links#docusaurus#Documentation#BUILD#flet#yarN
One-click install
npx skills add https://github.com/flet-dev/flet --skill docs-build-and-verify
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-build-and-verify
Source: https://github.com/flet-dev/flet/tree/main/.agents/skills/docs-build-and-verify
Command: npx skills add https://github.com/flet-dev/flet --skill docs-build-and-verify

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintaining a large Docusaurus documentation site makes it easy to ship broken links, missing images, and unresolved reST cross-references that degrade the reader experience. This Skill provides the exact commands to build, preview, and verify the Flet documentation website before publishing.

Core Features & Use Cases

  • Production Build with Link Checking: Runs yarn build in the website directory, which automatically fails on broken links and anchors.
  • Broken Image Detection: Scans generated HTML for image references that do not exist in the build output.
  • Unresolved reST Reference Detection: Greps built pages for raw :attr:, :class:, :meth:, and :func: roles that failed to resolve into links.
  • Use Case: After editing Flet documentation pages, run the full build and verification checks to confirm no broken links, missing images, or unresolved cross-references were introduced before merging.

Quick Start

Build the Flet documentation website and check it for broken links, broken images, and unresolved reST cross-references.

Frequently Asked Questions about docs-build-and-verify

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

FAQPage Schema
How do I build the Flet documentation website locally?▼

Run yarn build inside the website directory after switching to Node.js 20 with nvm. The production build compiles the Docusaurus site and automatically reports broken links and anchors, failing if any are found.

How to check for broken images in a Docusaurus build?▼

After running yarn build, execute the provided Python script that scans generated HTML files for img tags and verifies each referenced file exists in the build output. It prints a list of pages and sources for any missing images.

How do I preview Flet docs with hot reload during editing?▼

Run yarn start inside the website directory to launch the Docusaurus dev server with hot reload. This lets you see documentation changes immediately without running a full production build.

Why do reST cross-references appear as plain text in built docs?▼

Unresolved reST roles like :attr: or :class: render as raw text when the target cannot be resolved during the build. Grep the build output for these role patterns to find pages where cross-references failed to convert into links.

What Node.js version is required to build the Flet website?▼

Node.js 20 is required to build the Flet documentation website. Use nvm use 20 to switch to the correct version before running yarn build or yarn start.

Related Skills

Explore More Software Engineering Skills→
CliMACliMA
90

docstrings

Generate and normalize Julia package docstrings and sync API pages.

Official
Advanced
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
mcj-codermcj-coder
1

documentation-as-code

Lint, spell-check, and validate links in Markdown documentation files.

Community
Intermediate
SARAMALI15792SARAMALI15792
7

docusaurus-deployer

Automate Docusaurus site deployment to GitHub Pages with local validation.

Community
Advanced