Skip to content

Documentation UX: Reconsider placement and handling of reference links #372

@coderabbitai

Description

@coderabbitai

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

  1. 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.

  2. 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.

  3. 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

References

/cc @bmunkholm

Metadata

Metadata

Assignees

No one assigned

    Labels

    cross linkingLinking to different locations of the documentation.guidanceMatters of layout, shape, and structure.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions