Skip to content

#000 - improve UI#652

Merged
sbrossie merged 34 commits intov3from
000-improve-UI
Mar 10, 2026
Merged

#000 - improve UI#652
sbrossie merged 34 commits intov3from
000-improve-UI

Conversation

@pierre
Copy link
Member

@pierre pierre commented Feb 18, 2026

This pull request reorganizes and enhances the documentation sidebar navigation to improve usability and discoverability. It restructures the table of contents into clearer thematic groups, adds new sections and links, consolidates related topics, and introduces visual improvements such as badges and sidebar scrolling. Additionally, it includes minor HTML improvements for standards compliance.

Key improvements include:

Navigation Structure & Content Organization:

  • Major reorganization of the sidebar in html5/_main_toc.html.slim to group documentation topics into clearer, more intuitive sections (e.g., "Understand Kill Bill", "Get Started", "Core Concepts", "Integration", "Deploy & Operate", "Plugins", "Reference", "Internal", etc.). Several links were moved, renamed, or consolidated for better flow and easier access. [1] [2] [3]
  • Addition of new sidebar sections, including "Tutorials & Examples" and "Insider Preview" for Aviate, with new or previously less-visible links surfaced, such as technical FAQs, glossary, debugging, and various client libraries. [1] [2]

Visual and Usability Enhancements:

  • Replaced colored dots with more descriptive badge-premium labels for premium features, improving clarity. [1] [2]
  • Added a sidebar divider and labels for special sections like "Insider Preview" in the Aviate documentation.
  • Added a script to automatically scroll the sidebar so the active navigation item is visible on page load, improving navigation experience.

Technical/HTML Improvements:

  • Added a missing <meta charset="UTF-8"> tag to the HTML head in html5/document.html.slim for proper character encoding.

These changes collectively make the documentation easier to navigate, more visually consistent, and more accessible for both new and experienced users.

vnandwana and others added 30 commits February 11, 2026 19:58
* Covered fresh install and Flyway adoption scenarios.
…, schema drift, baseline too low or too high, and concurrent startup.
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Each plan modification now creates its own catalog version so
the effectiveDate matches the modified plan's effectiveDate,
rather than grouping multiple modifications into the same version.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
Explains the relationship between the Aviate control plane and the
Aviate plugin, with an embedded overview diagram.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Add Overview section to what_is_aviate.adoc with architecture diagram
Updated copy command to use recursive flag (cp -rf) to include nested directories
…g-docs

Update Aviate catalog versioning behavior documentation

=== Refund with Invoice Adjustment

When `isAdjusted` is `true`, the refund also adjusts the invoice — the invoice balance is reduced by the refund amount. Use this when you want to both return money and correct the invoice.

Check warning

Code scanning / QDJVMC

Style Warning

This sentence might be clearer in the active voice
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Mar 9, 2026

Deploying docs-killbill-io with  Cloudflare Pages  Cloudflare Pages

Latest commit: de46f7b
Status: ✅  Deploy successful!
Preview URL: https://abf3e4c0.docs-killbill-io.pages.dev
Branch Preview URL: https://000-improve-ui.docs-killbill-io.pages.dev

View logs

@sbrossie sbrossie mentioned this pull request Mar 9, 2026
@sbrossie sbrossie merged commit de46f7b into v3 Mar 10, 2026
4 checks passed
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.

5 participants