Skip to content

Commit ce8fa3f

Browse files
committed
docs: replace examples on first page with links
1 parent 1042f13 commit ce8fa3f

File tree

1 file changed

+6
-27
lines changed

1 file changed

+6
-27
lines changed

docs/get-started/overview.qmd

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -129,32 +129,11 @@ quartodoc:
129129
The functions listed in `contents` are assumed to be imported from the package.
130130

131131

132-
## Example sites
132+
## Learning more
133133

134-
### Demo sites
134+
Go [to the next page](./get-started/basic-docs.qmd) to learn how to configure quartodoc sites, or check out these handy pages:
135135

136-
| style | source | layout |
137-
| ----- | ------ | ------ |
138-
| [pkgdown] | [github][pkgdown-code] | Index page with a title and short description for functions listed in each section. Each function gets its own documentation page. |
139-
| [single-page] | [github][sp-code] | Index page has function documentation embedded on it. |
140-
141-
### Packages using quartodoc
142-
143-
144-
| package | source | about |
145-
| ----- | ------ | ------ |
146-
| [siuba] | [github][sb-code] | Data analysis library. |
147-
| [shiny][shiny] | | Dashboarding framework. |
148-
| [vetiver][vetiver] | [github][vt-code] | A tool to version, share, deploy and monitor ML models. |
149-
150-
: {tbl-colwidths="[20, 20, 60]"}
151-
152-
[pkgdown]: /examples/pkgdown/reference
153-
[pkgdown-code]: https://github.com/machow/quartodoc/tree/main/examples/pkgdown
154-
[single-page]: /examples/single-page/reference
155-
[sp-code]: https://github.com/machow/quartodoc/tree/main/examples/single-page
156-
[shiny]: https://shiny.rstudio.com/py/api/
157-
[vetiver]: https://rstudio.github.io/vetiver-python/stable/reference/
158-
[vt-code]: https://github.com/rstudio/vetiver-python
159-
[siuba]: https://siuba.org/api/
160-
[sb-code]: https://github.com/machow/siuba.org
136+
* [Examples page](./examples/index.qmd): sites using quartodoc.
137+
* [Tutorials page](./tutorials/index.qmd): screencasts of building a quartodoc site.
138+
* [Docstring issues and examples](./get-started/docstring-examples.qmd): common issues when formatting docstrings.
139+
* [Programming, the big picture](./get-started/dev-big-picture.qmd): the nitty gritty of how quartodoc works, and how to extend it.

0 commit comments

Comments
 (0)