-
Notifications
You must be signed in to change notification settings - Fork 1
Description
Problem
The current documentation approach places reference links on the right side at the top of pages (using side panels or similar layouts). This can be distracting for readers as it draws attention while reading the main content, creating uncertainty about what information might be missed.
Proposed improvements
-
Move reference links to the bottom: Place reference links at the end of pages as "more reading" sections, allowing readers to focus on the main content first.
-
Remove obvious references: Eliminate links to common knowledge resources (e.g., Wikipedia entries for widely known concepts) and assume readers can look these up independently if needed.
-
Create general guidelines: Add guidance about reference linking to the general author guidelines to ensure consistency across documentation.
Context
This affects multiple documentation pages across the crate/cratedb-guide repository. While this concern was raised during review of PR #361, it represents a broader documentation design principle that should be addressed systematically.
Examples
- https://cratedb.com/docs/guide/connect/
- https://cratedb.com/docs/guide/feature/sql/
- https://cratedb.com/docs/guide/feature/document/
- https://cratedb.com/docs/guide/feature/relational/
- https://cratedb.com/docs/guide/feature/search/fts/
- https://cratedb.com/docs/guide/feature/search/geo/
- https://cratedb.com/docs/guide/feature/search/vector/
References
- Related PR: Connect: Reorganize and clean up section #361
- Original comment: Connect: Reorganize and clean up section #361 (comment)
- See also: Improve general guidance aka. easy user journey #227
/cc @bmunkholm