[PR #338] docs: added more detailed setup instruction for linux #374

New issue

Open

opened 2026-03-02 12:40:54 +03:00 by kerem · 0 comments

kerem commented

2026-03-02 12:40:54 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/kavishdevar/librepods/pull/338
Author: @jaunger-app
Created: 11/29/2025
Status: 🔄 Open

Base: main ← Head: jaunger/docs

📝 Commits (5)

987b798 docs: added more detailed setup instruction for linux and linted the most markdown errors
e4a1444 fix(docs):Correct capitalization of 'Xposed'
b02de7f feat(ci): added Markdownlint job to lint all md files.
95d5c88 Merge branch 'main' into jaunger/docs
6ca2c91 fix(docs): capitalized Apple right and removed some other markdownlint errors

📊 Changes

7 files changed (+199 additions, -68 deletions)

View changed files

📝 .github/workflows/ci-android.yml (+11 -1)
📝 .github/workflows/ci-linux-rust.yml (+10 -0)
📝 .github/workflows/ci-linux.yml (+11 -0)
📝 AAP Definitions.md (+64 -34)
📝 CHANGELOG.md (+1 -0)
📝 README.md (+58 -19)
📝 linux/README.md (+44 -14)

📄 Description

This PR improves overall documentation quality by addressing several Markdown issues and enhancing the clarity of the installation instructions.

Summary by CodeRabbit

Documentation
- Reflowed and restructured headings, paragraphs and lists for improved readability; minor punctuation/capitalization edits and clearer notes across docs.
- Added a Troubleshooting section and expanded Linux setup/build/run instructions with reordered steps.
Changelog
- Added a “See here” reference entry under the project changelog header.
Chores
- Added Markdown linting steps to CI workflows to validate documentation formatting (non-blocking).

_{✏️ Tip: You can customize this high-level summary in your review settings.}

_{🔄 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/kavishdevar/librepods/pull/338 **Author:** [@jaunger-app](https://github.com/jaunger-app) **Created:** 11/29/2025 **Status:** 🔄 Open **Base:** `main` ← **Head:** `jaunger/docs` --- ### 📝 Commits (5) - [`987b798`](https://github.com/kavishdevar/librepods/commit/987b798eb044a5015002e08f51a583d1e861aaea) docs: added more detailed setup instruction for linux and linted the most markdown errors - [`e4a1444`](https://github.com/kavishdevar/librepods/commit/e4a14446b9bebd517452787eeb51986cb890e58c) fix(docs):Correct capitalization of 'Xposed' - [`b02de7f`](https://github.com/kavishdevar/librepods/commit/b02de7fed4085524133894a507eb0fb8b599fd91) feat(ci): added Markdownlint job to lint all md files. - [`95d5c88`](https://github.com/kavishdevar/librepods/commit/95d5c88ca4242407a02c43cba6a8ba9c29f87811) Merge branch 'main' into jaunger/docs - [`6ca2c91`](https://github.com/kavishdevar/librepods/commit/6ca2c91561af6f6a0e59ab387fe413aaa8f7a40d) fix(docs): capitalized Apple right and removed some other markdownlint errors ### 📊 Changes **7 files changed** (+199 additions, -68 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/ci-android.yml` (+11 -1) 📝 `.github/workflows/ci-linux-rust.yml` (+10 -0) 📝 `.github/workflows/ci-linux.yml` (+11 -0) 📝 `AAP Definitions.md` (+64 -34) 📝 `CHANGELOG.md` (+1 -0) 📝 `README.md` (+58 -19) 📝 `linux/README.md` (+44 -14) </details> ### 📄 Description This PR improves overall documentation quality by addressing several Markdown issues and enhancing the clarity of the installation instructions.  ## Summary by CodeRabbit * **Documentation** * Reflowed and restructured headings, paragraphs and lists for improved readability; minor punctuation/capitalization edits and clearer notes across docs. * Added a Troubleshooting section and expanded Linux setup/build/run instructions with reordered steps. * **Changelog** * Added a “See here” reference entry under the project changelog header. * **Chores** * Added Markdown linting steps to CI workflows to validate documentation formatting (non-blocking). <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub>  --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>