docs: added more detailed setup instruction for linux

Open jaunger-app opened this issue 1 month ago • 1 comments

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.}

Nov 29 '25 11:11 jaunger-app

Walkthrough

Demoted several top-level headings to second-level and reflowed/cleaned prose across documentation; added a Troubleshooting header and explicit build/run steps in linux docs; inserted a changelog line. Added Markdown-linting CI jobs to Android, Linux, and Linux‑Rust workflows (docs/CI only). (50 words)

Changes

Cohort / File(s)	Summary
Documentation (general) `AAP Definitions.md`, `README.md`, `linux/README.md`, `CHANGELOG.md`	Converted some `#` headings to `##`; reflowed paragraphs and fixed minor punctuation/capitalization; added a Troubleshooting header and explicit "Create the build directory" / "Run the application" steps in `linux/README.md`; added a "See here" line in `CHANGELOG.md`.
CI workflows (markdown linting) `.github/workflows/ci-android.yml`, `.github/workflows/ci-linux.yml`, .github/workflows/ci-linux-rust.yml`	Added new linting jobs that checkout the repo and run Markdown linting (markdownlint actions) over `*/.md` (or similar globs) with `continue-on-error: true`. No existing job logic was modified.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Review focus:
- Validate new CI job syntax, placement, and action versions in each .github/workflows/* file.
- Confirm globs and continue-on-error: true are intentional.
- Check that heading-level changes didn't break internal anchors/links or table-of-contents rendering.
- Render linux/README.md to confirm numbering, code blocks, and new build/run steps display as intended.

Poem

🐰 I nudged the headings, smoothed each line with care,

Hid build-step carrots in the docs' neat lair.
I flicked on lint lights in workflows late at night,
Now README hums and changelogs wink polite. 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title specifically references Linux setup instructions as a main focus, but the PR includes substantial Markdown formatting fixes across multiple files and CI linting workflow additions that are equally significant.	Consider revising the title to reflect the full scope: 'docs: improve markdown formatting and add detailed linux setup instructions' or similar, to accurately represent all major changes in the changeset.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

[ ] Create PR with unit tests
[ ] Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 95d5c88ca4242407a02c43cba6a8ba9c29f87811 and 6ca2c91561af6f6a0e59ab387fe413aaa8f7a40d.

📒 Files selected for processing (3)

AAP Definitions.md (17 hunks)
README.md (6 hunks)
linux/README.md (8 hunks)

🧰 Additional context used

🪛 LanguageTool

AAP Definitions.md

[uncategorized] ~17-~17: Did you mean the proper noun “Apple Silicon”? Context: ...atures behind specific OS versions, and Apple silicon devices, some packets are necessary to ...

(APPLE_PRODUCTS)

[grammar] ~284-~284: Ensure spelling is correct Context: ...on-Apple devices than on Apple devices, becuase on Apple Devices, there are just 3 opti...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

[grammar] ~287-~287: Ensure spelling is correct Context: ...n set any value between 0 and 100.* ## Accessiblity Settings ## Headphone Accomodation ``...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

[grammar] ~289-~289: Ensure spelling is correct Context: ... ## Accessiblity Settings ## Headphone Accomodation plaintext 04 00 04 00 53 00 84 00 02 02 [Phone] [Media] [EQ1][EQ2][EQ3][EQ4][EQ5][EQ6][EQ7][EQ8] duplicated thrice for some reason | Data | Type | ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

README.md

[style] ~57-~57: Consider using a more formal alternative. Context: ...etup and starts LibrePods. If you need more help, check the [Linux README](./linux/READM...

(MORE_HELP)

[style] ~58-~58: To elevate your writing and sound more professional, you can use different wording here. Context: ...e many features, maintainer didn't have time to work on it) new version in developm...

(DIDNT_HAVE_THE_TIME)

[grammar] ~93-~93: Ensure spelling is correct Context: ...igures out a fix. Until then, you must Xposed. I used to provide a non-Xposed method ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

linux/README.md

[grammar] ~159-~159: Ensure spelling is correct Context: ...providing the values for 8 frequencies (250Hz, 500Hz, 1kHz, 2kHz, 3kHz, 4kHz, 6kHz, 8...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

[grammar] ~159-~159: Ensure spelling is correct Context: ...ng the values for 8 frequencies (250Hz, 500Hz, 1kHz, 2kHz, 3kHz, 4kHz, 6kHz, 8kHz) fo...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

[grammar] ~159-~159: Ensure spelling is correct Context: ...values for 8 frequencies (250Hz, 500Hz, 1kHz, 2kHz, 3kHz, 4kHz, 6kHz, 8kHz) for both...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

[grammar] ~159-~159: Ensure spelling is correct Context: ... for 8 frequencies (250Hz, 500Hz, 1kHz, 2kHz, 3kHz, 4kHz, 6kHz, 8kHz) for both left ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

[grammar] ~159-~159: Ensure spelling is correct Context: ... frequencies (250Hz, 500Hz, 1kHz, 2kHz, 3kHz, 4kHz, 6kHz, 8kHz) for both left and ri...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

[grammar] ~159-~159: Ensure spelling is correct Context: ...encies (250Hz, 500Hz, 1kHz, 2kHz, 3kHz, 4kHz, 6kHz, 8kHz) for both left and right ea...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

[grammar] ~159-~159: Ensure spelling is correct Context: ... (250Hz, 500Hz, 1kHz, 2kHz, 3kHz, 4kHz, 6kHz, 8kHz) for both left and right ears. Th...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

[grammar] ~159-~159: Ensure spelling is correct Context: ...z, 500Hz, 1kHz, 2kHz, 3kHz, 4kHz, 6kHz, 8kHz) for both left and right ears. There ar...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🔇 Additional comments (2)

linux/README.md (1)

78-101: LGTM! The setup section restructuring greatly improves clarity.

The explicit three-step flow (create build directory → build application → run application) is much clearer than the previous approach. Users now have obvious, copy-paste-ready instructions with separate explanatory context for each step. This is a solid UX improvement for the documentation.

README.md (1)

46-58: LGTM! The new Linux installation sub-section is clear and user-friendly.

The detailed step-by-step instructions with separate paragraphs and a reference to the more comprehensive linux/README.md documentation are well-structured. This directly addresses the PR objective of providing more detailed setup instructions for Linux and makes onboarding much easier.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Nov 29 '25 11:11 coderabbitai[bot]