Skip to content

Commit 518af34

Browse files
committed
Refine API reference descriptions
1 parent cd3f41b commit 518af34

1 file changed

Lines changed: 12 additions & 9 deletions

File tree

great-docs.yml

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -330,18 +330,21 @@ nav_icons:
330330
# Explicit control over API reference organization
331331
reference:
332332
desc: >-
333-
The API reference for Great Docs is organized around the `GreatDocs` class,
334-
which provides all of the methods needed to initialize, build, and deploy
335-
documentation sites.
333+
The API reference for Great Docs is organized around the `GreatDocs` class, which provides all
334+
of the methods needed to initialize, build, and deploy documentation sites.
336335
sections:
337-
- title: Classes
338-
desc: Core classes and types.
336+
- title: The GreatDocs Class
337+
desc: >-
338+
The central class that orchestrates site initialization, building, and deployment for your
339+
Python package documentation.
339340
contents:
340341
- name: GreatDocs
341342
members: false
342343

343344
- title: GreatDocs Methods
344-
desc: Methods for the GreatDocs class.
345+
desc: >-
346+
Methods for installing dependencies, building the documentation site, launching a live
347+
preview, and validating links across all pages.
345348
contents:
346349
- GreatDocs.install
347350
- GreatDocs.uninstall
@@ -351,15 +354,15 @@ reference:
351354

352355
- title: Table Preview/Explorer
353356
desc: >-
354-
Generate styled HTML table previews from any tabular data source with
355-
`tbl_preview()`, and explore tables interactively with `tbl_explorer()`.
357+
Generate styled HTML table previews from any tabular data source with `tbl_preview()`, and
358+
explore tables interactively with `tbl_explorer()`.
356359
contents:
357360
- tbl_preview
358361
- enable_tbl_preview
359362
- disable_tbl_preview
360363
- tbl_explorer
361364

362-
- title: Agent Skills
365+
- title: Skills
363366
desc: >-
364367
Install, check, and list Agent Skills from the Python API.
365368
contents:

0 commit comments

Comments
 (0)