Skip to content

Commit 41f0813

Browse files
committed
Polish user guide link summaries
1 parent 7976797 commit 41f0813

1 file changed

Lines changed: 40 additions & 29 deletions

File tree

pages/user-guide/index.yml

Lines changed: 40 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -17,47 +17,58 @@ overview:
1717
start:
1818
label: Start here
1919
content: |
20-
- [Installation and GitHub Actions](index=pages/user-guide/tutorials/00-installation-and-github-actions.yml)
21-
- Install the packages, run locally, and add a GitHub Actions workflow.
22-
- [YAML Pages and Sections](index=pages/user-guide/tutorials/01-yaml-pages-and-sections.yml)
23-
- Learn the top-to-bottom page model with rendered examples.
24-
- [Section Controls](index=pages/user-guide/tutorials/02-section-controls.yml)
25-
- Add labels, templates, defaults, and renderer dispatch.
26-
- [Links and Page Discovery](index=pages/user-guide/tutorials/03-links-and-page-discovery.yml)
27-
- Link Markdown, notebooks, YAML pages, and static assets.
20+
These pages are the shortest path from an empty repository to a working
21+
Webifier site. Read them in order if you are setting up a project for the
22+
first time.
23+
24+
- [Installation and GitHub Actions](index=pages/user-guide/tutorials/00-installation-and-github-actions.yml): install the packages, render locally, and add a GitHub Actions workflow.
25+
- [YAML Pages and Sections](index=pages/user-guide/tutorials/01-yaml-pages-and-sections.yml): learn the top-to-bottom page model with rendered examples.
26+
- [Section Controls](index=pages/user-guide/tutorials/02-section-controls.yml): add labels, templates, defaults, and renderer dispatch.
27+
- [Links and Page Discovery](index=pages/user-guide/tutorials/03-links-and-page-discovery.yml): link Markdown, notebooks, YAML pages, and static assets.
2828
2929
default_workflow:
3030
label: Default workflow
3131
content: |
32-
- [Using the Default Site](md=pages/user-guide/01-default-site.md)
33-
- [Render and Automate](md=pages/user-guide/02-render-and-automate.md)
34-
- [Navigation and Pages](md=pages/user-guide/03-navigation-and-pages.md)
35-
- [Publishing Content Files](md=pages/user-guide/04-content-files.md)
36-
- [Configuration Basics](md=pages/user-guide/05-configuration.md)
32+
The default workflow covers the pieces most projects use immediately:
33+
choosing an entry point, publishing from source files, and letting automation
34+
do the repeat work.
35+
36+
- [Using the Default Site](md=pages/user-guide/01-default-site.md): start from the bundled layout and understand what Webifier renders for you.
37+
- [Render and Automate](md=pages/user-guide/02-render-and-automate.md): run the build locally and wire it into repository publishing.
38+
- [Navigation and Pages](md=pages/user-guide/03-navigation-and-pages.md): configure site navigation and decide which pages belong in the guide.
39+
- [Publishing Content Files](md=pages/user-guide/04-content-files.md): publish Markdown, notebooks, HTML, PDFs, and assets from your repository.
40+
- [Configuration Basics](md=pages/user-guide/05-configuration.md): keep site-level defaults, page settings, and extension options in one place.
3741
3842
renderers:
3943
label: Renderers and Extensions
4044
content: |
41-
- [Renderer Catalog](index=pages/user-guide/renderers/index.yml)
42-
- [Page and Section Renderers](index=pages/user-guide/renderers/01-page-and-section-renderers.yml)
43-
- [Content and Link Renderers](index=pages/user-guide/renderers/02-content-and-link-renderers.yml)
44-
- [Extension Renderers](index=pages/user-guide/renderers/03-extension-renderers.yml)
45-
- [Bundled Extensions](index=pages/user-guide/extensions/bundled.yml)
46-
- [Themes and Styles](md=pages/user-guide/06-themes.md)
47-
- [Template Overrides](md=pages/user-guide/07-template-overrides.md)
48-
- [Template-Only Renderers](md=pages/user-guide/08-template-renderers.md)
49-
- [Python Renderers and Resolvers](md=pages/user-guide/09-python-renderers-and-resolvers.md)
50-
- [Reusable Website Formats](md=pages/user-guide/10-reusable-formats.md)
45+
Renderers and extensions are where Webifier becomes reusable. Start with the
46+
built-ins, then move toward your own templates, Python renderers, and
47+
packaged website formats.
48+
49+
- [Renderer Catalog](index=pages/user-guide/renderers/index.yml): compare the bundled renderer categories and where each one fits.
50+
- [Page and Section Renderers](index=pages/user-guide/renderers/01-page-and-section-renderers.yml): define complete pages and structured sections.
51+
- [Content and Link Renderers](index=pages/user-guide/renderers/02-content-and-link-renderers.yml): render files and links into discoverable website pages.
52+
- [Extension Renderers](index=pages/user-guide/renderers/03-extension-renderers.yml): understand how extensions register renderers, assets, hooks, and templates.
53+
- [Bundled Extensions](index=pages/user-guide/extensions/bundled.yml): see what ships with Webifier and how to enable it.
54+
- [Themes and Styles](md=pages/user-guide/06-themes.md): set defaults, switch themes, and prepare for custom visual systems.
55+
- [Template Overrides](md=pages/user-guide/07-template-overrides.md): replace specific templates without rewriting the whole site.
56+
- [Template-Only Renderers](md=pages/user-guide/08-template-renderers.md): add new rendering kinds from templates alone.
57+
- [Python Renderers and Resolvers](md=pages/user-guide/09-python-renderers-and-resolvers.md): plug in Python code when templates are not enough.
58+
- [Reusable Website Formats](md=pages/user-guide/10-reusable-formats.md): package repeatable formats for resumes, labs, academic sites, and project pages.
5159
5260
reference:
5361
label: Reference
5462
content: |
55-
- [Architecture Overview](md=pages/user-guide/reference/00-overview.md)
56-
- [YAML Syntax Specification](md=pages/user-guide/reference/01-yaml-syntax.md)
57-
- [Resolver System](md=pages/user-guide/reference/02-resolvers.md)
58-
- [Renderer / Kind System](md=pages/user-guide/reference/03-renderers.md)
59-
- [Extension and Customization Guide](md=pages/user-guide/reference/04-extension-guide.md)
60-
- [Processing Pipeline](md=pages/user-guide/reference/05-processing-pipeline.md)
63+
Use the reference pages when you need exact syntax, lifecycle details, or a
64+
deeper mental model for extending Webifier.
65+
66+
- [Architecture Overview](md=pages/user-guide/reference/00-overview.md): see the core pieces and how extensions fit around them.
67+
- [YAML Syntax Specification](md=pages/user-guide/reference/01-yaml-syntax.md): check the supported YAML shapes and reserved keys.
68+
- [Resolver System](md=pages/user-guide/reference/02-resolvers.md): understand how links, files, and generated pages are discovered.
69+
- [Renderer / Kind System](md=pages/user-guide/reference/03-renderers.md): map `kind`, templates, and renderer dispatch.
70+
- [Extension and Customization Guide](md=pages/user-guide/reference/04-extension-guide.md): write extensions that register renderers, hooks, templates, and assets.
71+
- [Processing Pipeline](md=pages/user-guide/reference/05-processing-pipeline.md): follow the build lifecycle from config loading to output files.
6172
6273
shape:
6374
label: Workflow

0 commit comments

Comments
 (0)