write-landing-docs

Write public LobeHub website documentation covering self-hosting, deployment, migration, and configuration guides.

Updated Jan 27, 2026
One-click install
npx skills add https://github.com/SmallAi-API/smaihub --skill write-landing-docs-smallai-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: write-landing-docs
Source: https://github.com/SmallAi-API/smaihub/tree/main/.agents/skills/write-landing-docs
Command: npx skills add https://github.com/SmallAi-API/smaihub --skill write-landing-docs-smallai-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Maintaining accurate, consistent public documentation for a product website is hard: claims drift from actual code behavior, English and Chinese versions fall out of sync, and changed URLs break existing links. This Skill enforces a disciplined workflow for authoring LobeHub website docs under docs/** so pages stay verified, canonical, and aligned across locales. ## Core Features & Use Cases - Verified technical content: Requires checking claims, defaults, commands, limitations, and rollback behavior against current source code before publishing. - Self-hosting audience guidance: Ships a reference file defining the default audience (individuals and small teams) so deployment and migration guides recommend the simplest supported path rather than cloud-scale setups. - Locale and link integrity: Keeps English and Simplified Chinese versions aligned, and mandates tested permanent redirects that preserve locale prefixes and query parameters when paths change. - Use Case: You need to document a new Docker deployment option. The Skill directs you to read the design voice guidelines, verify commands against the codebase, write short executable steps with a visible verification result, and run the focused documentation check. ## Quick Start Use the write-landing-docs skill to draft a self-hosting deployment guide for docs/self-hosting that follows the design voice and verifies all commands against the current code.

Frequently Asked Questions about write-landing-docs

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

FAQPage Schema
How do I write self-hosting documentation for LobeHub?

Read the self-hosting audience reference first, then write a short numbered procedure with exact settings, commands, and a visible verification result. Prefer the supported option with the fewest extra services, and verify every claim against the current code.

What documentation does the write-landing-docs skill cover?

It covers public website documentation under docs/**, including self-hosting, deployment, migration, and configuration guides. It explicitly excludes product changelogs, which use a separate docs-changelog skill, and source-code API documentation.

How do I keep English and Chinese documentation versions aligned?

Author both English and Simplified Chinese versions together as part of the same change, keeping structure and content equivalent. The skill requires locale alignment as a core rule for every published page.

What should I do when a documentation page URL changes?

Update all internal links pointing to the old path and add a tested permanent redirect in the landing repository. The redirect must preserve locale prefixes and query parameters so existing bookmarks and localized links keep working.

When should I not use the write-landing-docs skill?

Do not use it for product changelog entries under docs/changelog/**, which belong to the docs-changelog skill, or for source-code API documentation. It is scoped to public-facing website guides only.