Skip to content

docs: Restructure documentation with separate introduction section#771

Draft
patrikbraborec wants to merge 4 commits intomasterfrom
docs/restructure-introduction-section
Draft

docs: Restructure documentation with separate introduction section#771
patrikbraborec wants to merge 4 commits intomasterfrom
docs/restructure-introduction-section

Conversation

@patrikbraborec
Copy link
Contributor

@patrikbraborec patrikbraborec commented Feb 10, 2026

Summary

Re-applies the documentation restructuring from #740 (which was reverted in #763).

  • Split the monolithic overview page into three focused pages: Introduction, Installation, and Quick start
  • Reorganized documentation structure by moving webserver guide from concepts to guides section
  • Renumbered concept pages to maintain proper ordering after moving webserver content
  • Updated sidebar configuration to create a dedicated Introduction category
  • Updated redirect on landing page to point to /docs/introduction

Test plan

  • Verify all internal links work correctly
  • Check that the sidebar navigation displays properly
  • Confirm all code examples and images are accessible
  • Review the new three-page structure for logical flow

🤖 Generated with Claude Code

@github-actions github-actions bot added the t-c&c Team covering store and finance matters. label Feb 10, 2026
@patrikbraborec patrikbraborec marked this pull request as draft February 10, 2026 16:31
@codecov
Copy link

codecov bot commented Feb 10, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.53%. Comparing base (6034c49) to head (a597912).
⚠️ Report is 21 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #771      +/-   ##
==========================================
+ Coverage   81.91%   85.53%   +3.62%     
==========================================
  Files          46       46              
  Lines        2693     2697       +4     
==========================================
+ Hits         2206     2307     +101     
+ Misses        487      390      -97
Flag Coverage Δ
integration 57.47% <ø> (+1.51%) ⬆️
unit 72.52% <ø> (+4.45%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@patrikbraborec @claude
docs: Restructure introduction section into a streamlined overview
c3d57af 
Consolidate the introduction section by merging installation info into the
overview page, removing the separate installation page, and flattening the
sidebar navigation. Update slugs and redirect paths to use /overview.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@patrikbraborec patrikbraborec requested a review from TC-MO February 10, 2026 16:57
@patrikbraborec
Copy link
Contributor Author

patrikbraborec commented Feb 10, 2026

@TC-MO I did the same changes as in JS SDK (structure-wise). Please check it.

TC-MO
TC-MO requested changes Feb 16, 2026
View reviewed changes
Copy link
Contributor

@TC-MO TC-MO left a comment

Choose a reason for hiding this comment

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

One big ticket item - but seems that can be future work we discussed previously.
Other than that, remove gerunds from headings and we should be okay to merge this restructure & work further on the content

patrikbraborec and others added 2 commits February 16, 2026 12:52
@patrikbraborec @TC-MO
Apply suggestions from code review
ffc0ca1 
Co-authored-by: Michał Olender <92638966+TC-MO@users.noreply.github.com>
@patrikbraborec @claude
docs: Align overview page with JS SDK structure
a597912 
Simplify the overview by linking to the standalone quick start page
instead of duplicating its content. Add Python version requirement
to the installation section and update the code example.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@patrikbraborec
Copy link
Contributor Author

patrikbraborec commented Feb 16, 2026

@TC-MO thanks, I little bit edited the overview (aligned it with JS SDK). I agree with you about the content. I would address in the follow up PRs, though.

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

Reviewers

@TC-MO TC-MO TC-MO approved these changes

Assignees

@patrikbraborec patrikbraborec

Labels

t-c&c Team covering store and finance matters.

Projects

None yet

Milestone

134th sprint - Cash & Community team

Development

Successfully merging this pull request may close these issues.

2 participants

@patrikbraborec @TC-MO