Skip to content

📂 Flatten single page readmes - #2759

Open
JFWooten4 wants to merge 8 commits into
stellar:mainfrom
JFWooten4:2731-flatten-single-page-readmes
Open

📂 Flatten single page readmes#2759
JFWooten4 wants to merge 8 commits into
stellar:mainfrom
JFWooten4:2731-flatten-single-page-readmes

Conversation

@JFWooten4

@JFWooten4 JFWooten4 commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

All the remaining after #2450 finished

Copilot AI balanced review requested due to automatic review settings August 18, 2026 07:32
Copilot AI reviewed Aug 18, 2026
View reviewed changes

Copilot AI 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.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates MDX documentation links and reorganizes the Horizon “Liquidity Pools” resource doc to a new location within the API reference resources.

Changes:

  • Adjusts internal reference links in SEP-10 and SEP-45 docs.
  • Moves the Horizon Liquidity Pools resource doc from a nested README.mdx to a top-level liquiditypools.mdx.
  • Updates the Horizon resources index to point to the new Liquidity Pools doc path.

Reviewed changes

Copilot reviewed 5 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/platforms/anchor-platform/sep-guide/sep45/README.mdx Updates SEP-1 link reference used by SEP-45 guide
docs/platforms/anchor-platform/sep-guide/sep10/README.mdx Fixes Stellar CLI doc link path and updates SEP-1 link reference
docs/data/apis/horizon/api-reference/resources/liquiditypools/README.mdx Removes nested Liquidity Pools resource page (migrated)
docs/data/apis/horizon/api-reference/resources/liquiditypools.mdx Adds new top-level Liquidity Pools resource page with updated relative links
docs/data/apis/horizon/api-reference/resources/README.mdx Updates index link to Liquidity Pools resource page

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@JFWooten4
JFWooten4 force-pushed the 2731-flatten-single-page-readmes branch from 5cc40ba to 4819b54 Compare August 18, 2026 07:52
@ElliotFriend
ElliotFriend requested a review from wmendes August 31, 2026 15:40
@kaankacar
Keep liquiditypools as a directory
f20ef74 
src/sidebar-generator.js injects the generated Horizon endpoint pages
only into sidebar items of type category. Flattening the folder turns
the Liquidity Pools item into a doc, which drops the six /liquidity_pools
endpoints from the API reference sidebar.
Copilot AI review requested due to automatic review settings September 8, 2026 22:10
@kaankacar

kaankacar commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

🤖 Automated message from Kaan's Automated Triage Bot.

Reviewing because a review was requested by @wmendes.

liquiditypools is not a single-page folder on the rendered site. src/sidebar-generator.js adds the generated Horizon endpoint pages only to sidebar items of type category. Flattening the folder makes it a doc, so the six /liquidity_pools endpoints leave the API reference sidebar.

I pushed a commit that keeps that one folder. The other four flattens look correct:

  • The page URLs do not change, so routes.txt and redirects.conf stay the same.
  • Every updated relative link resolves.

Next I will trigger a preview build and check the sidebars there.

@kaankacar

kaankacar commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

ok to test

Copilot AI reviewed Sep 8, 2026
View reviewed changes

Copilot AI 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.

Pull request overview

Copilot reviewed 19 out of 21 changed files in this pull request and generated 1 comment.

Suppressed comments (1)

docs/platforms/anchor-platform/sep-guide/sep45.mdx:142

  • This docs-internal target is still root-absolute. Use a relative .mdx link so it works with the repository's configured base URL and follows the docs link convention.

Comment thread docs/platforms/anchor-platform/admin-guide/events/integration.mdx Outdated
@kaankacar
Point the clients-config link at the Client Configuration heading
d785769 
The SEP-10 page has no config-with-client-attribution heading, so the
link landed readers at the top of the page. Client Configuration is the
section that documents the clients list.
Copilot AI review requested due to automatic review settings September 9, 2026 00:08
Copilot AI reviewed Sep 9, 2026
View reviewed changes

Copilot AI 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.

Pull request overview

Copilot reviewed 19 out of 21 changed files in this pull request and generated no new comments.

@kaankacar

kaankacar commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

🤖 Automated message from Kaan's Automated Triage Bot.

Reviewing because a review was requested from @wmendes by @ElliotFriend.

  • Verified: URLs and sidebar order do not change, so routes.txt and redirects.conf stay as they are. All checks are green.
  • I fixed Copilot's one finding: the SEP-10 link carried a broken heading anchor. I rejected its sep45.mdx point, because that line is pre-existing and check-relative-links.sh exempts untouched lines by design.
  • Correction: my earlier "ok to test" cannot work here. pr-preview needs org membership, so a fork PR gets no preview. The green build / build is the render evidence.
  • External-origin change, so a maintainer merges this. Ready to merge.

@kaankacar kaankacar added the bot:ready-to-merge Bot verified and approved; waiting for a maintainer to merge label Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kaankacar kaankacar kaankacar left review comments
Copilot code review Copilot
Copilot review effort, defaults to Balanced
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@wmendes wmendes Awaiting requested review from wmendes

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

bot:ready-to-merge Bot verified and approved; waiting for a maintainer to merge

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@JFWooten4 @kaankacar