Skip to content

docs: Restructure quick-start guide into separate end-to-end guides for clp-json and clp-text.#968

Merged
kirkrodrigues merged 42 commits into
y-scope:mainfrom
quinntaylormitchell:docs-json-text-separation
Jul 3, 2025
Merged

docs: Restructure quick-start guide into separate end-to-end guides for clp-json and clp-text.#968
kirkrodrigues merged 42 commits into
y-scope:mainfrom
quinntaylormitchell:docs-json-text-separation

Conversation

@quinntaylormitchell

@quinntaylormitchell quinntaylormitchell commented Jun 5, 2025

Copy link
Copy Markdown
Collaborator

Description

The quick-start section of CLP docs integrated explanations of clp-json and clp-text throughout, and it was split up into multiple pages to be more readable. This PR untangles these sections from one another and puts each on an independent page; in addition, it compiles all quick-start information for each flavour on a single page, rather than multiple pages. This will allow more room for the docs of each flavour to grow, and also make explanation of each flavour more streamlined. In addition, the page on multi-node development which was formerly part of the quick-start guide was moved to "Guides" so as not to complicate the new quick-start flow.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Served website to local host, tried every link on every page; no bad links. All workflows passed.

Summary by CodeRabbit

  • Documentation
    • Reorganised the user guide navigation for clearer access to quick-start content.
    • Introduced new consolidated quick-start guides for clp-json and clp-text flavours, replacing multiple previous documents including cluster setup, compression, and search.
    • Added a multi-node deployment guide and updated object storage references to specify clp-json flavour support.
    • Updated terminology from "release" to "flavour" and enhanced navigation cards for improved user guidance.
    • Provided a new overview quick-start guide detailing system requirements, flavour differences, and usage notes.

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants