[PR #245] [MERGED] fix(docs): correct overview navigation #286

Closed
opened 2026-10-29 14:21:49 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/kvcache-ai/AgentENV/pull/245
Author: @yingdi-shan
Created: 9/4/2026
Status: ✅ Merged
Merged: 9/4/2026
Merged by: @yingdi-shan

Base: main ← Head: fix/docs-overview-links


📝 Commits (1)

  • c558024 fix(docs): correct overview navigation

📊 Changes

2 files changed (+21 additions, -0 deletions)

View changed files

➕ docs/src/index.html (+20 -0)
📝 docs/src/stoplight-elements.html (+1 -0)

📄 Description

Summary

  • replace mdBook's broken root-level first-chapter alias with a relative redirect to the canonical getting-started overview
  • preserve query strings and fragments when redirecting from a version root
  • display the volumes OpenAPI tag as Volumes in the Stoplight API reference

Testing

  • make docs
  • verified the emitted book/index.html matches the redirect source
  • verified the overview and its linked documentation pages exist in the built book
  • parsed the inline Stoplight adapter script after adding the display-name substitution

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/kvcache-ai/AgentENV/pull/245 **Author:** [@yingdi-shan](https://github.com/yingdi-shan) **Created:** 9/4/2026 **Status:** ✅ Merged **Merged:** 9/4/2026 **Merged by:** [@yingdi-shan](https://github.com/yingdi-shan) **Base:** `main` ← **Head:** `fix/docs-overview-links` --- ### 📝 Commits (1) - [`c558024`](https://github.com/kvcache-ai/AgentENV/commit/c5580248a7b4127c79bb1c06b4e52dc54ea25185) fix(docs): correct overview navigation ### 📊 Changes **2 files changed** (+21 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `docs/src/index.html` (+20 -0) 📝 `docs/src/stoplight-elements.html` (+1 -0) </details> ### 📄 Description ## Summary - replace mdBook's broken root-level first-chapter alias with a relative redirect to the canonical getting-started overview - preserve query strings and fragments when redirecting from a version root - display the `volumes` OpenAPI tag as `Volumes` in the Stoplight API reference ## Testing - `make docs` - verified the emitted `book/index.html` matches the redirect source - verified the overview and its linked documentation pages exist in the built book - parsed the inline Stoplight adapter script after adding the display-name substitution --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-10-29 14:21:49 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
kvcache-ai/AgentENV#286
No description provided.