Practice vocabulary for documentation sites: platforms like Docusaurus, versioning, Algolia DocSearch, feedback widgets, and CI link checking.
0 / 5 completed
1 / 5
Popular static documentation site generators used by developer tools and open-source projects include:
The docs site uses Docusaurus/MkDocs/GitBook — these are the most popular documentation-specific platforms; Docusaurus is backed by Meta and widely used in open source.
2 / 5
When a documentation site maintains separate documentation for version 1 and version 2 of a product simultaneously, this is called:
Versioned documentation for v1 and v2 — essential for products where users may be on different versions. Docusaurus and MkDocs both support versioning natively.
3 / 5
The documentation search feature powered by a third-party service that indexes and serves fast search results is called:
The search bar is powered by Algolia DocSearch — Algolia DocSearch is free for open-source docs and provides the fast, relevant search that documentation sites need.
4 / 5
A UI element on a docs page that lets readers rate whether the documentation was helpful is called:
The feedback widget collects doc quality ratings — typically thumbs up/down or star rating; the data helps identify which pages need improvement.
5 / 5
When an automated process in CI verifies that all links in the documentation are valid and not broken, this is called:
The broken link checker runs in CI — tools like lychee, link-checker, or built-in Docusaurus checks catch dead links before they reach production.