docs: place Office warnings within feature sections (#1764)
* docs: place Office warnings within feature sections * test(docs): cover substantive status sections * docs: attach experimental badges to Office features * test(docs): cover callouts without section headings
This commit is contained in:
@@ -34,13 +34,15 @@ The docs header renders a visible status callout from that frontmatter. To invok
|
||||
Use a section-level indicator when a stable guide contains one experimental capability. Keep this source syntax as Markdown so older renderers and GitHub still show an explicit callout; the publication layer upgrades it to the styled status component:
|
||||
|
||||
```markdown
|
||||
## Office status
|
||||
## Office dependencies
|
||||
|
||||
> [!EXPERIMENTAL]
|
||||
> Office is disabled by default and its public workflow is not stable yet.
|
||||
> Office is feature-flagged and its dependency editor is not stable yet.
|
||||
|
||||
When Office is enabled, it can record blocked-by relationships between tasks. Use parent/child structure and workflow gates for the supported regular-Kanban path.
|
||||
```
|
||||
|
||||
Keep the indicator next to the relevant heading and explain the enabling condition, current limit, and supported alternative. The publication pipeline converts the callout to `FeatureStatus` and opts the generated page into MDX automatically.
|
||||
Place the indicator immediately after a descriptive heading that names the experimental capability, then follow it with the instructions or behavior it qualifies. Explain the enabling condition, current limit, and supported alternative. Do not drop a warning between otherwise stable paragraphs or create a standalone status section whose only content is the warning. The publication pipeline converts the callout to `FeatureStatus` and opts the generated page into MDX automatically.
|
||||
|
||||
## Add a page
|
||||
|
||||
|
||||
Reference in New Issue
Block a user