Skip to content

Commit 7a3e4e1

Browse files
committed
feat: update docs for Incomplete
1 parent 90b0b52 commit 7a3e4e1

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

src/content/docs/development/guide/component-docs-for-llm.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,22 @@ The `DR` component renders a single defect report.
403403

404404
See above.
405405

406+
## Incomplete
407+
408+
The `Incomplete` component marks a section to be incomplete.
409+
410+
#### Props
411+
412+
- `reason` (required): The reason why the section is incomplete.
413+
414+
#### Usage
415+
416+
417+
import Incomplete from "@components/Incomplete.astro"
418+
419+
<Incomplete reason="no usage" />
420+
421+
406422
## Missing Content
407423

408424
### Missing

src/content/docs/development/guide/doc-everything.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import { Desc, DescList } from "@components/desc-list";
1212
import DocLink from "@components/DocLink.astro";
1313
import { DR, DRList } from "@components/defect-report";
1414
import { FeatureTestMacro, FeatureTestMacroValue } from "@components/feature-test-macro";
15+
import Incomplete from "@components/Incomplete.astro";
1516
import Missing from "@components/Missing.astro";
1617
import NamedReq from "@components/NamedReq.astro"
1718
import { ParamDoc, ParamDocList } from "@components/param-doc";
@@ -538,6 +539,20 @@ import { DR, DRList } from "@components/defect-report";
538539
</DRList>
539540
</Card>
540541

542+
## Incomplete Sections
543+
544+
The `Incomplete` component marks a section to be incomplete.
545+
546+
```mdx
547+
import { Incomplete } from "@components/Incomplete.astro";
548+
549+
<Incomplete reason="more examples" />
550+
```
551+
552+
<Card title="Preview">
553+
<Incomplete reason="more examples" />
554+
</Card>
555+
541556
## Missing Content
542557

543558
The `Missing` component could be used for marking content that is still missing.

0 commit comments

Comments
 (0)