[PR #703] [CLOSED] #WIP: Documentation revamp #741

New issue

Closed

opened 2026-02-25 23:35:19 +03:00 by kerem · 0 comments

kerem commented

2026-02-25 23:35:19 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/go-shiori/shiori/pull/703
Author: @fmartingr
Created: 8/20/2023
Status: ❌ Closed

Base: master ← Head: fmartingr/issue663

📝 Commits (9)

99b4844 Update README
52b2bea Remove unmantained postman collection
4813ffe wip
23f0d8e Add guidance for deploying with Fly.io (#706)
ab43024 mkdocs wip
c804355 check documentation in actions
7ac8376 remove swagger dependency
51d22db build -> check
ac911a8 add publish step to actions

📊 Changes

25 files changed (+322 additions, -603 deletions)

View changed files

➕ .github/workflows/_mkdocs-check.yml (+18 -0)
➕ .github/workflows/_mkdocs-publish.yml (+19 -0)
📝 .github/workflows/pull_request.yml (+3 -1)
📝 .github/workflows/version_bump.yml (+4 -0)
📝 .gitignore (+4 -0)
📝 Makefile (+12 -0)
📝 README.md (+14 -9)
➖ docs/Installation.md (+0 -51)
📝 docs/_old/Configuration.md (+0 -0)
📝 docs/_old/Frequently-Asked-Question.md (+0 -0)
📝 docs/_old/Screenshots.md (+0 -0)
📝 docs/_old/Storage.md (+0 -0)
📝 docs/_old/Usage.md (+0 -0)
➕ docs/assets/css/style.css (+3 -0)
➕ docs/getting_started/installation.md (+101 -0)
➕ docs/images/logo.png (+0 -0)
📝 docs/index.md (+52 -10)
➖ docs/postman/shiori.postman_collection.json (+0 -512)
➕ docs/requirements.txt (+4 -0)
➕ docs/swagger/spec.md (+1 -0)

...and 5 more files

📄 Description

Fixes: #663 #274

_{🔄 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/go-shiori/shiori/pull/703 **Author:** [@fmartingr](https://github.com/fmartingr) **Created:** 8/20/2023 **Status:** ❌ Closed **Base:** `master` ← **Head:** `fmartingr/issue663` --- ### 📝 Commits (9) - [`99b4844`](https://github.com/go-shiori/shiori/commit/99b4844833cac4d2eca155f5f92e164d45db093c) Update README - [`52b2bea`](https://github.com/go-shiori/shiori/commit/52b2beaa74903e5fbe106d4e1cc987e322fcc452) Remove unmantained postman collection - [`4813ffe`](https://github.com/go-shiori/shiori/commit/4813ffefb228499d52bf4b15cc4efdcc3f08cc4b) wip - [`23f0d8e`](https://github.com/go-shiori/shiori/commit/23f0d8e0263de1a6f015278b83cbd4fa6c14da3a) Add guidance for deploying with Fly.io (#706) - [`ab43024`](https://github.com/go-shiori/shiori/commit/ab4302461f9440fa97c22b5cf80dbc7939f29356) mkdocs wip - [`c804355`](https://github.com/go-shiori/shiori/commit/c8043551b0d919b3f279a890889b3ba4f54e5372) check documentation in actions - [`7ac8376`](https://github.com/go-shiori/shiori/commit/7ac8376281800ad1b5e0e2360f113f0ec94d15f2) remove swagger dependency - [`51d22db`](https://github.com/go-shiori/shiori/commit/51d22db5c29aa0c181ae794c9195628171abf5c5) build -> check - [`ac911a8`](https://github.com/go-shiori/shiori/commit/ac911a84bc03ad30ab61d248edafcfccfda59f9d) add publish step to actions ### 📊 Changes **25 files changed** (+322 additions, -603 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/_mkdocs-check.yml` (+18 -0) ➕ `.github/workflows/_mkdocs-publish.yml` (+19 -0) 📝 `.github/workflows/pull_request.yml` (+3 -1) 📝 `.github/workflows/version_bump.yml` (+4 -0) 📝 `.gitignore` (+4 -0) 📝 `Makefile` (+12 -0) 📝 `README.md` (+14 -9) ➖ `docs/Installation.md` (+0 -51) 📝 `docs/_old/Configuration.md` (+0 -0) 📝 `docs/_old/Frequently-Asked-Question.md` (+0 -0) 📝 `docs/_old/Screenshots.md` (+0 -0) 📝 `docs/_old/Storage.md` (+0 -0) 📝 `docs/_old/Usage.md` (+0 -0) ➕ `docs/assets/css/style.css` (+3 -0) ➕ `docs/getting_started/installation.md` (+101 -0) ➕ `docs/images/logo.png` (+0 -0) 📝 `docs/index.md` (+52 -10) ➖ `docs/postman/shiori.postman_collection.json` (+0 -512) ➕ `docs/requirements.txt` (+4 -0) ➕ `docs/swagger/spec.md` (+1 -0) _...and 5 more files_ </details> ### 📄 Description Fixes: #663 #274 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>