agentleFS
yasikyasik/agentlane/.agents/skills/docs-portal/SKILL.md

docs-portal

Skill9 starsChanged 15 days agoMITView on GitHub

Rebuild and verify the AgentLane website documentation portal after docs-sync or edits to root documentation, navigation, or portal rendering.

The file

We split this skill into the rules it gives an agent

11 rules. About 0 are common, 5 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Keep public Markdown in root docs/.

    line 8
  2. Very specific:

    If you change documentation prose, use dev-docs from the session's skill catalog.

    line 13
  3. Very specific:

    Use Node.js 24 and pnpm 10.29.3.

    line 17
  4. Very specific:

    Run make -C website check.

    line 19
  5. Distinctive:

    Use relative Markdown links in source files so they also work on GitHub.

    line 30
  6. Very specific:

    Keep docs/README.md as the documentation home.

    line 41
  7. Distinctive:

    Use a nested folder's README title and route for its group.

    line 43
  8. Distinctive:

    Every public page must appear once in navigation and remain in search.

    line 47
  9. Distinctive:

    Use concise Markdown page titles.

    line 48
  10. Very specific:

    Use docs/README.md to order siblings.

    line 52
  11. Distinctive:

    Check the generated structure against every public source path.

    line 59

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Documentation portal

Keep public Markdown in root docs/. Astro reads those files directly. docs/plans/ is internal and must stay out of routes, navigation, and search.

Workflow

  1. If you change documentation prose, use dev-docs from the session's skill catalog. Apply its review checklist to the changed pages. Reuse a completed review from docs-sync when the text has not changed. If the skill is missing, report that limitation and do not claim a completed style review.
  2. Use Node.js 24 and pnpm 10.29.3. From the repository root, install the website dependencies with make -C website install if needed.
  3. Run make -C website check. This checks formatting and types, builds the website from root documentation, and tests the generated routes and links.
  4. Fix failures within the changed scope and repeat the check. For layout or interaction changes, use make -C website dev to check a changed page on desktop and mobile. Check navigation, search, code blocks, and both themes.
  5. Report the source pages, check results, and unresolved failures. Generated files stay in ignored website/dist/; do not commit them.

The build creates /docs/ from docs/README.md. Other Markdown files retain their relative path without .md; nested README files use directory routes. The build derives navigation and search from the same public collection. Use relative Markdown links in source files so they also work on GitHub.

The website workflow runs on public docs changes. Deployment uses the website's normal release process. A local rebuild does not publish the site.

Navigation contract

Apply these rules to all public documentation on every rebuild:

  • Discover every public Markdown file under docs/ recursively. Folder paths define section membership and nesting depth. Exclude docs/plans/.
  • Keep docs/README.md as the documentation home. Use each top-level folder as a section, with its README page first if present.
  • Use a nested folder's README title and route for its group. Show that page once. A folder without a README has a label without a link; do not create a page or route for it.
  • Derive the sidebar, breadcrumbs, and previous/next links from the same tree. Every public page must appear once in navigation and remain in search.
  • Use concise Markdown page titles. Omit parent names that the hierarchy already supplies. Group tool references under Harness > Tools and use each exact tool name as its title, without a "Tool" suffix. Apply title changes in source Markdown so pages, navigation, and search agree.
  • Use docs/README.md to order siblings. Top-level label and order overrides can remain, but must not select pages or limit nesting. Do not add manual hierarchy lists for specific sections or providers.
  • Include added folders and pages automatically, even when the documentation index does not list them. When moving sources, repair incoming links because folder paths also determine routes.

Check the generated structure against every public source path. Verify folder ancestry, README placement, page coverage, and links across the documentation.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.