Skip to content

Conversation

@eric-stacks
Copy link
Collaborator

Description

  • reorganizes the sbtc pages to different appropriate sections
  • removed old docs content and configs
  • removed some broken links in the README (will need to revise a new README later on)

@eric-stacks eric-stacks requested a review from a team as a code owner November 3, 2025 12:20
@claude
Copy link

claude bot commented Nov 3, 2025

PR Review: Reorganized sBTC pages, removed old docs content

Overview

This PR removes old Docusaurus build artifacts and reorganizes sBTC documentation. Given the massive size (30K+ deletions), I've reviewed the PR metadata and repository structure.

Positive Aspects

  1. Cleanup of Build Artifacts: Removing the .docusaurus directory is excellent - these are generated files that should never be committed to version control.

  2. Documentation Organization: Reorganizing sBTC pages into more appropriate sections improves discoverability and maintainability.

  3. Broken Link Removal: Cleaning up broken links in the README improves user experience.

Issues and Recommendations

Critical: .gitignore Update Needed

Issue: The .docusaurus directory was committed in the first place, suggesting it's not in .gitignore.

Action Required: Please verify that .docusaurus/, build/, and node_modules/ are all properly excluded in .gitignore to prevent these files from being committed again.

If these aren't present, add them:

.docusaurus/
build/
node_modules/

High: Missing Details on sBTC Reorganization

Issue: The PR description says "reorganizes the sbtc pages to different appropriate sections" but doesn't specify:

  • Which pages were moved
  • Where they were moved from/to
  • Why these new locations are more appropriate

Recommendation: For documentation PRs, especially reorganization, please provide:

  1. A table showing old path → new path for each moved file
  2. Rationale for the reorganization
  3. Any redirects or link updates needed

Medium: README Changes Not Visible

Issue: The PR mentions removing broken links from the README but with 12 additions and 30K deletions, it's unclear what was actually changed in the README.

Recommendation: For multi-faceted PRs like this, consider splitting into separate commits:

Commit 1: Remove .docusaurus build artifacts
Commit 2: Reorganize sBTC documentation pages
Commit 3: Fix broken README links

This makes review easier and provides clearer history.

Medium: Verify Internal Links

Issue: When reorganizing documentation, internal links often break.

Action Required: Please verify:

  1. All internal links to moved sBTC pages have been updated
  2. No 404s will result from this reorganization
  3. GitBook navigation/SUMMARY.md is updated if applicable

Low: Consider a Link Checker in CI

Suggestion: For future-proofing, consider adding a broken link checker to your CI pipeline (tools like markdown-link-check or linkinator).

Testing Checklist

Before merging, please verify:

  • .gitignore includes .docusaurus/, build/, node_modules/
  • All sBTC pages render correctly in their new locations
  • Internal navigation links work (especially in SUMMARY.md)
  • No broken internal links to moved pages
  • Search functionality still indexes all sBTC content
  • README renders correctly with links removed

Security & Performance

✅ No security concerns - this is a documentation cleanup PR.
✅ Positive performance impact - removing 30K lines of build artifacts will reduce repository size and clone times.

Questions

  1. Was this .docusaurus directory from an old Docusaurus setup that's no longer used? (The current repo appears to use GitBook)
  2. Are there any external links pointing to the old sBTC page locations that need redirects?
  3. Has this been tested on a local build to ensure the GitBook structure is still valid?

Overall Assessment: This is a valuable cleanup PR, but would benefit from better documentation of the changes and verification that .gitignore is properly configured to prevent future build artifact commits.

Copy link
Collaborator

@kenny-stacks kenny-stacks left a comment

Choose a reason for hiding this comment

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

lgtm

@kenny-stacks kenny-stacks merged commit ba4f240 into master Nov 3, 2025
12 checks passed
@kenny-stacks kenny-stacks deleted the chore/remove-old-docs branch November 3, 2025 17:15
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.

4 participants