Skip to content

README.md file changes - #13967

Open
stevenfelix505 wants to merge 8 commits into
TeamNewPipe:devfrom
stevenfelix505:dev
Open

stevenfelix505 wants to merge 8 commits into
TeamNewPipe:devfrom
stevenfelix505:dev

Conversation

@stevenfelix505

Copy link
Copy Markdown
Contributor

What is it?

  • Bugfix (user facing)
  • Feature (user facing)
  • Codebase improvement (dev facing)
  • Meta improvement to the project (dev facing)

Description of the changes in your PR

  • Existing README.md file in root and its content has been moved into the doc folder.
  • The README.md file in root is now a symbolic link file to render the README.md file content from the doc folder.

Before/After Screenshots/Screen Record

  • Before:
  • After:

Fixes the following issue(s)

  • Fixes #

Might be relies on the following changes

Testing/QA

Devices
  • tested on device(phone) running Android 11 / Google Chrome 156.0.8078.73
Steps i do for testing
  • i forked the upstream NewPipe repository.
  • i created a new file called README.md inside the doc folder, with the content copied from README.md file in root.
  • then i use GitHub codespaces to run these following terminal commands :
    • rm README.md to remove existing README.md file in root.
    • ln -s doc/README.md README.md to create a symbolic link file in root called README.md to render the README.md file content from the doc folder.
    • then i commited all the changes above in GitHub codespaces.
  • after doing all things above, i stopped currently running GitHub codespaces to make sure all the changes above still applied correctly & not lost.
  • then i created this pull request.
APK for testing (optional)

The APK can be found by going to the "Checks" tab below the title. On the left pane, click on "CI", scroll down to "artifacts" and click "app" to download the zip file which contains the debug APK of this PR. You can find more info and a video demonstration on this wiki page.

Due diligence

@github-actions github-actions Bot added size/large PRs with less than 750 changed lines template-ignored labels Oct 28, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Please link this PR to an existing issue you are assigned to. Assignees are expected to discuss the details of the PR beforehand. This PR will be closed if it is not linked to an issue.

…he images will be rendered properly on both symlink README.md file in root and the README.md file inside doc folder
…ages so the images will be rendered properly on each README.md files
@github-actions github-actions Bot added size/giant PRs with more than 750 changed lines and removed size/large PRs with less than 750 changed lines labels Oct 29, 2026
@TobiGr TobiGr mentioned this pull request Oct 29, 2026
3 of 7 tasks
@TobiGr
TobiGr requested a review from theimpulson October 29, 2026 10:18
@TobiGr TobiGr added the meta Related to the project but not strictly to code label Oct 29, 2026
…e user clicks on the language hyperlinks (on both symlink README.md file in root and the README.md file inside doc folder) it will be redirected to the correct page (no more 404 status code)
…o when the user clicks on the language hyperlinks (on each README.md files) it will be redirected to the correct page (no more 404 status code)
@sonarqubecloud

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

meta Related to the project but not strictly to code size/giant PRs with more than 750 changed lines template-ignored

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants