Website Documentation Update Policy
Languages: English · 中文
Agently capability changes usually affect code, examples, release notes, compatibility metadata, Agently-Skills, and website documentation. The main repository docs/ is the shared technical source. The website consumes that source and adds presentation: navigation, SEO, dual-domain routing, style, homepage, and marketing pages.
Update Order
- Framework release work updates code, examples, release notes, compatibility information, and main-repo docs.
- The website syncs technical docs from the main repository.
- Website-only pages are adjusted when positioning, customer cases, homepage copy, careers, or trademark/license statements change.
- Build and link checks run before upload.
This keeps release facts close to the code while preserving the website's reader path and presentation quality.
What to Check After Each Release
| Area | Focus |
|---|---|
| Homepage | Current version, capability entrypoints, case links, install path |
| Docs home | Whether the recommended reading path needs to change |
| Capability map | Whether new capability changes scenario selection |
| Core tutorials | API names, recommended entrypoints, code examples |
| Glossary | New terms, migration terms, compatibility state |
| Cases | Whether example files still exist and output descriptions come from real runs |
| Agently-Skills | Whether coding-agent guidance still recommends the same path |
What Should Not Auto-Publish
- Source refresh without rewriting and review.
- Maintainer notes, site planning notes, or synchronization implementation details as public content.
- Unverified customer promises, performance claims, or production results.
- Old APIs accidentally presented as new-project recommendations.
Where Readers Confirm Versions
- Current release notes: Agently 4.1.3.6 Release Notes
- Release workflow: Release Workflows
- Documentation principles: Documentation Update Principles
- Compatibility and migration entrypoint: Glossary