Agent skill
gitbook-1-structure-content-properly
Sub-skill of gitbook: 1. Structure Content Properly (+3).
Install this agent skill to your Project
npx add-skill https://github.com/vamseeachanta/workspace-hub/tree/main/.claude/skills/_archive/development/documentation/gitbook/1-structure-content-properly
SKILL.md
1. Structure Content Properly (+3)
1. Structure Content Properly
# Good structure
docs/
├── README.md # Landing page
├── SUMMARY.md # Navigation
├── getting-started/
│ ├── README.md # Section intro
│ ├── installation.md
│ └── quickstart.md
└── guides/
├── README.md
└── ...
2. Use Meaningful Slugs
# SUMMARY.md - Good slugs
* [Installation Guide](getting-started/installation.md)
* [API Reference](api/reference.md)
# Avoid
* [Page 1](page1.md)
* [Untitled](untitled-1.md)
3. Maintain Version Consistency
# Use consistent version naming
versions = [
{"title": "v1.0", "slug": "v1"},
{"title": "v2.0", "slug": "v2"},
{"title": "Latest", "slug": "latest"}
]
4. Validate Before Publish
def validate_docs(docs_path):
"""Validate docs before publishing."""
issues = []
# Check SUMMARY.md exists
if not (docs_path / "SUMMARY.md").exists():
issues.append("Missing SUMMARY.md")
# Check all linked files exist
# Check for broken internal links
# Check image paths
return issues
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
vamseeachanta/workspace-hub
gsd-complete-milestone
Archive completed milestone and prepare for next version
vamseeachanta/workspace-hub
gsd-reapply-patches
Reapply local modifications after a GSD update
vamseeachanta/workspace-hub
gsd-verify-work
Validate built features through conversational UAT
vamseeachanta/workspace-hub
gsd-thread
Manage persistent context threads for cross-session work
vamseeachanta/workspace-hub
clinical-trial-protocol
Generate clinical trial protocols for medical devices or drugs through a modular, waypoint-based architecture with research-only and full protocol modes.
vamseeachanta/workspace-hub
single-cell-rna-qc
Performs quality control on single-cell RNA-seq data (.h5ad or .h5 files) using scverse best practices with MAD-based filtering and comprehensive visualizations.
Didn't find tool you were looking for?