Skip to content

docs(reference): reorganize Reference sidebar into logical categories - #206

Open
me-valenzuela wants to merge 4 commits into
docs-v2from
docs/reorganize-reference-sidebar
Open

docs(reference): reorganize Reference sidebar into logical categories#206
me-valenzuela wants to merge 4 commits into
docs-v2from
docs/reorganize-reference-sidebar

Conversation

@me-valenzuela

@me-valenzuela me-valenzuela commented Sep 4, 2026

Copy link
Copy Markdown

Summary

Reorganize the flat Reference sidebar (27 pages in a single list) into seven logical categories so developers can find topics by intent instead of scrolling one long list. This is a navigation-only change — no docs were moved and no page URLs changed. It also removes a dead sidebar entry that was breaking the local dev server on docs-v2.

Related Jira: PRODUCT-203

Changes

  • Group the Reference sidebar into: Setup & Authentication, Hardware & Devices, Payments & Features, Transaction Recovery, Testing & Validation, Technical Reference, Troubleshooting.
  • Remove the orphaned back-office/rest-api-no-reader entry from the Acquirers sidebar. Its doc was deleted in 2c7c0d9 but the sidebar entry stayed, which made docusaurus start fail on docs-v2 with "Invalid sidebar file".

How to test

  1. yarn install
  2. yarn start
  3. Open the Reference section in the left sidebar and confirm the seven categories and their contents.
  4. Confirm the dev server boots without the "Invalid sidebar file" error.

Screenshots

Captura de pantalla 2026-09-04 a las 18 09 39

Checklist

  • Code builds and runs locally
  • Tests added/updated and passing — N/A (documentation navigation only)
  • No secrets, keys, tokens or cardholder data committed
  • Jira ticket linked and updated — PRODUCT-203
  • Screenshots attached where relevant

Notes for reviewers

  • Navigation-only: no .md/.mdx files were moved and no slug values changed, so every page URL is unchanged and no redirects are needed.
  • The rest-api-no-reader removal is a drive-by fix required for this branch to build; it also fixes docs-v2 itself. Happy to split it into its own PR if you prefer.

me-valenzuela and others added 3 commits September 4, 2026 17:45
Split the flat Reference menu into seven categories (Setup &
Authentication, Hardware & Devices, Payments & Features, Transaction
Recovery, Testing & Validation, Technical Reference, Troubleshooting).
Sidebar-only change: no files moved, no doc URLs changed.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The rest-api-no-reader.md doc was deleted in 2c7c0d9 but its sidebar
entry stayed, breaking `docusaurus start` on docs-v2. Remove the
orphaned reference so the site builds.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Show the MOTO overview before the AVS-for-MOTO detail page,
since AVS builds on the MOTO concept.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
alexdll31 added a commit that referenced this pull request Sep 9, 2026
Merges Mireya's PR #206. Groups the flat 27-item Reference list into
seven categories: Setup & Authentication, Hardware & Devices, Payments
& Features, Transaction Recovery, Testing & Validation, Technical
Reference, and Troubleshooting. Navigation-only change — no URLs moved.

Co-Authored-By: me-valenzuela <me-valenzuela@users.noreply.github.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

1 participant