Skip to content

Restructure docs for useforge.ai sync pipeline#47

Merged
initializ-mk merged 2 commits intomainfrom
docs/useforgesyncsetup
Apr 20, 2026
Merged

Restructure docs for useforge.ai sync pipeline#47
initializ-mk merged 2 commits intomainfrom
docs/useforgesyncsetup

Conversation

@initializ-mk
Copy link
Copy Markdown
Contributor

Summary

  • Reorganize flat docs/ directory into site-matching subdirectories: getting-started/, core-concepts/, security/, skills/, deployment/, reference/, plus faq.md
  • Add YAML frontmatter (title, description, order) to every doc for automated sync
  • Strip H1 headers, breadcrumbs, and navigation lines

Splits

  • skills.md (27KB) → 6 files: skill-md-format, embedded-skills, writing-custom-skills, skills-cli, contributing-a-skill, your-first-skill
  • deployment.md → 4 files: docker, kubernetes, production-checklist, monitoring
  • configuration.md → 3 files: configuration, forge-yaml-schema, environment-variables
  • security/overview.md → 3 files: overview, trust-model, audit-logging

New standalone pages

  • reference/agent-skills-compatibility.md — compatibility matrix for skills across providers
  • faq.md — frequently asked questions

Why

The useforge.ai sync pipeline fetches docs from this repo at build time. It expects:

  1. Subdirectory structure matching the site's sections
  2. YAML frontmatter with title, description, order
  3. No H1 headers or navigation breadcrumbs (handled by the site layout)

Test plan

  • Every new file has valid YAML frontmatter
  • No content was lost — all original doc content exists in the restructured files
  • No broken cross-references within the new structure

Reorganize flat docs/ directory into site-matching subdirectories:
- getting-started/, core-concepts/, security/, skills/,
  deployment/, reference/, plus faq.md

Add YAML frontmatter (title, description, order) to every doc.
Strip H1 headers, breadcrumbs, and navigation lines.

Split monolithic docs:
- skills.md → 6 files (skill-md-format, embedded-skills,
  writing-custom-skills, skills-cli, contributing-a-skill,
  your-first-skill)
- deployment.md → 4 files (docker, kubernetes,
  production-checklist, monitoring)
- configuration.md → 3 files (configuration, forge-yaml-schema,
  environment-variables)
- security/overview.md → 3 files (overview, trust-model,
  audit-logging)

Create standalone pages: agent-skills-compatibility.md, faq.md
Sends a repository_dispatch event to initializ/useforge.ai
when docs/ files are pushed to main, triggering a docs sync
and Cloudflare Pages rebuild.

Requires USEFORGE_DISPATCH_TOKEN secret (PAT with repo scope
on initializ/useforge.ai).
@initializ-mk initializ-mk merged commit f17a223 into main Apr 20, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant