[PR #216] [MERGED] docs: link Concepts and API from the docs index #212

New issue

Closed

opened 2026-10-13 19:48:56 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-13 19:48:56 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Glitchy-Sheep/boosty-downloader/pull/216
Author: @Glitchy-Sheep
Created: 9/24/2026
Status: ✅ Merged
Merged: 9/24/2026
Merged by: @Glitchy-Sheep

Base: main ← Head: docs/index-concepts-and-api

📝 Commits (1)

04e2faa docs: link Concepts and API from the docs index

📊 Changes

1 file changed (+2 additions, -0 deletions)

View changed files

📝 docs/README.md (+2 -0)

📄 Description

📝 Summary

The docs index listed only Development. Nothing linked to docs/concepts/ and docs/api/, so a reader opening docs/ could not find them.

🔧 What changes

docs/README.md gets two rows: Concepts (download flow, tolerant reader, path limits, Renovate) and API (the observed Boosty API schema).

✅ Checklist

Tested live on a real blog (feature or fix)
Updated CLI --help and README if needed
Updated docs/ if the download flow or dev process changed
Added a line to ## Unreleased in CHANGELOG.md (or the ci/skip-changelog label if not user-facing)

_{🔄 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/Glitchy-Sheep/boosty-downloader/pull/216 **Author:** [@Glitchy-Sheep](https://github.com/Glitchy-Sheep) **Created:** 9/24/2026 **Status:** ✅ Merged **Merged:** 9/24/2026 **Merged by:** [@Glitchy-Sheep](https://github.com/Glitchy-Sheep) **Base:** `main` ← **Head:** `docs/index-concepts-and-api` --- ### 📝 Commits (1) - [`04e2faa`](https://github.com/Glitchy-Sheep/boosty-downloader/commit/04e2faaaba015c13dc3eb12f2bf0e5643e723cb9) docs: link Concepts and API from the docs index ### 📊 Changes **1 file changed** (+2 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/README.md` (+2 -0) </details> ### 📄 Description ## 📝 Summary The docs index listed only Development. Nothing linked to `docs/concepts/` and `docs/api/`, so a reader opening `docs/` could not find them. ## 🔧 What changes - `docs/README.md` gets two rows: Concepts (download flow, tolerant reader, path limits, Renovate) and API (the observed Boosty API schema). ## ✅ Checklist  - [x] Tested live on a real blog (feature or fix) - [x] Updated CLI `--help` and README if needed - [x] Updated `docs/` if the download flow or dev process changed - [x] Added a line to `## Unreleased` in CHANGELOG.md (or the `ci/skip-changelog` label if not user-facing) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-13 19:48:56 +00:00