Skip to content

Rewrite in-app documentation#3599

Open
PE39806 wants to merge 27 commits into
mainfrom
docs/rewrite-documentation
Open

Rewrite in-app documentation#3599
PE39806 wants to merge 27 commits into
mainfrom
docs/rewrite-documentation

Conversation

@PE39806

@PE39806 PE39806 commented May 14, 2026

Copy link
Copy Markdown
Collaborator
  • Remove all legacy frontend/pages/docs/v1 docs
  • Add new docs
  • Add new style guide page
  • Rewrite some existing docs to improve consistency and detail
  • Improve styling of docs sidebar title text size to differentiate nested levels more clearly
  • Improve documentation best practices for RAG applications

@PE39806 PE39806 changed the title Docs/rewrite documentation Rewrite in-app documentation May 14, 2026
@github-actions github-actions Bot added documentation Improvements or additions to documentation javascript Pull requests that update Javascript code frontend Changes affecting the user-facing interface, client-side code, or presentation layer. labels May 14, 2026
ARADDCC013
ARADDCC013 previously approved these changes May 14, 2026
Comment thread frontend/pages/docs/administration/review-roles/managing-review-roles.mdx Outdated
Comment thread frontend/pages/docs/administration/review-roles/managing-review-roles.mdx Outdated
Comment thread frontend/pages/docs/reference/glossary.mdx
Comment thread frontend/src/docs/DocsWrapper.tsx Outdated
@PE39806 PE39806 marked this pull request as ready for review May 21, 2026 11:14
ON93754
ON93754 previously approved these changes May 21, 2026
Comment thread frontend/pages/docs/administration/federation/peer-integration.mdx Outdated
Comment thread frontend/pages/docs/administration/federation/peer-integration.mdx Outdated
Comment thread frontend/pages/docs/administration/getting-started/deployment-architecture.mdx Outdated
Comment thread frontend/pages/docs/administration/microservices/artefact-scanners.mdx Outdated
Comment thread frontend/pages/docs/reference/roles-and-permissions.mdx
Comment thread frontend/pages/docs/administration/getting-started/app-configuration.mdx Outdated
Comment thread frontend/pages/docs/getting-started/core-concepts.mdx Outdated
Comment thread frontend/pages/docs/users/inferencing/creating-an-inference-service.mdx Outdated
Comment thread frontend/pages/docs/users/programmatically-using-bailo/authentication.mdx Outdated
Co-authored-by: GB907762 <241953074+GB907762@users.noreply.github.com>

@ARADDCC002 ARADDCC002 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is going to be a massive change... but should consider changing the capitalisation of the various headings and sub-headings?

For example, a sub-head of ## Example Sub-Heading, would become ## Example sub-heading. This wouldn't apply to proper nouns or anagrams, of course.

As this PR is already massive I'm happy for this to be done in the future.

Comment thread frontend/pages/docs/users/reviews/reviewing/model-lifecycle.mdx Outdated
Comment thread frontend/pages/docs/getting-started/quick-start.mdx Outdated
Comment thread frontend/pages/docs/getting-started/quick-start.mdx Outdated
Comment thread frontend/pages/docs/reference/troubleshooting.mdx

@JRB66955 JRB66955 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Read through the documentation (in-app) sequentially up to the Inferencing tab, happy about it other than my sole comment so far.

Comment thread frontend/pages/docs/users/using-scanners/file-scanning.mdx
@PE39806

PE39806 commented Jun 8, 2026

Copy link
Copy Markdown
Collaborator Author

This is going to be a massive change... but should consider changing the capitalisation of the various headings and sub-headings?

For example, a sub-head of ## Example Sub-Heading, would become ## Example sub-heading. This wouldn't apply to proper nouns or anagrams, of course.

As this PR is already massive I'm happy for this to be done in the future.

Just to make sure I've understood this correctly, the highest level (h1 equivalent #) should be Title Case and all subheadings (h2 equivalent ## etc.) should be Sentence case?

@PE39806 PE39806 requested a review from GB907762 June 8, 2026 08:09
Comment thread frontend/pages/docs/users/inferencing/creating-an-inference-service.mdx Outdated
Comment thread frontend/pages/docs/administration/schemas/create-a-schema.mdx Outdated
JRB66955
JRB66955 previously approved these changes Jun 8, 2026
Co-authored-by: JRB66955 <214850388+JRB66955@users.noreply.github.com>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@GB907762 GB907762 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I've got through it all now😆

LGTM

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

Labels

documentation Improvements or additions to documentation frontend Changes affecting the user-facing interface, client-side code, or presentation layer. javascript Pull requests that update Javascript code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants