Tolk Starter documentation
Two guides, for two kinds of reader:
- Developer guide: install the kit, configure it, deploy it and extend it.
- Editor guide: build pages, manage content, translate and publish in the admin.
The screenshots come from the demo site (pnpm seed:demo), taken by pnpm docs:screenshots.
Developer guide #
- Overview
- Install in ten minutes
- Configuration
- Deploy
- Extend
- Roles and access
- Testing
- Updating Tolk Starter
- Upgrading Payload
- Troubleshooting
- Recording a product walkthrough
- Demo pictures
- Demo translations
Editor guide #
- Overview
- Pages and blocks
- Sections and reusable sections
- Media
- Navigation and site settings
- News, jobs, dealers, cases and the catalog
- Languages
- Translation
- Roles
- Publishing, scheduling and review links
About these pages #
Every page starts with frontmatter: a title, a one-line description and an order within its folder. A folder's index.md gives the folder its title and its place. The pages are plain Markdown that MDX also accepts, so a docs site generator such as Fumadocs or Nextra can render them, with its navigation built from the titles and orders.
tests/unit/docs.test.ts keeps the pages honest: every relative link and image resolves, every page is listed here, the Markdown stays readable by MDX-based generators, and the environment variable table lists exactly the variables in .env.example. See Testing.