Improve documentation structure and content across GitHub Actions Runner #3987
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR significantly enhances the documentation for the GitHub Actions Runner repository to improve user experience and reduce setup friction. The changes address several pain points identified in the existing documentation while maintaining consistency with the project's style and structure.
Key Improvements Made
📚 Enhanced Main README
🛠️ Comprehensive OS Prerequisites
Updated all platform-specific setup guides with detailed instructions and troubleshooting:
Linux (
docs/start/envlinux.md
):Windows (
docs/start/envwin.md
):macOS (
docs/start/envosx.md
):📖 Improved Navigation and Structure
docs/README.md
) with organized sections and quick navigationdocs/contribute.md
)docs/checks/README.md
) with categorized issue types🔧 Enhanced Automation Documentation
docs/automate.md
with common issues and solutionsProblem Solved
The original documentation had several issues that created friction for users:
Impact
These improvements provide:
The documentation now serves as a complete resource for both new users getting started and experienced users implementing advanced configurations, while maintaining the project's existing style and approach.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/repos/TingluoHuang/REDACTED_L0/tarball/RepositoryActionWithInvalidWrapperActionfile_Node
/home/REDACTED/work/REDACTED/REDACTED/_dotnetsdk/8.0.412/dotnet exec --runtimeconfig /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/Test.runtimeconfig.json --depsfile /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/Test.deps.json /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/testhost.dll --port 33609 --endpoint 127.0.0.1:033609 --role client --parentprocessid 4147 --telemetryoptedin false
(http block)https://api.github.com/repos/TingluoHuang/REDACTED_L0/tarball/repositoryactionwithactionfileanddockerfile
/home/REDACTED/work/REDACTED/REDACTED/_dotnetsdk/8.0.412/dotnet exec --runtimeconfig /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/Test.runtimeconfig.json --depsfile /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/Test.deps.json /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/testhost.dll --port 33609 --endpoint 127.0.0.1:033609 --role client --parentprocessid 4147 --telemetryoptedin false
(http block)https://api.github.com/repos/TingluoHuang/REDACTED_L0/tarball/repositoryactionwithdockerfile
/home/REDACTED/work/REDACTED/REDACTED/_dotnetsdk/8.0.412/dotnet exec --runtimeconfig /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/Test.runtimeconfig.json --depsfile /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/Test.deps.json /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/testhost.dll --port 33609 --endpoint 127.0.0.1:033609 --role client --parentprocessid 4147 --telemetryoptedin false
(http block)https://api.github.com/repos/actions/download-artifact/tarball/master
/home/REDACTED/work/REDACTED/REDACTED/_dotnetsdk/8.0.412/dotnet exec --runtimeconfig /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/Test.runtimeconfig.json --depsfile /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/Test.deps.json /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/testhost.dll --port 33609 --endpoint 127.0.0.1:033609 --role client --parentprocessid 4147 --telemetryoptedin false
(http block)https://api.github.com/repos/actions/setup-node/tarball/v1
/home/REDACTED/work/REDACTED/REDACTED/_dotnetsdk/8.0.412/dotnet exec --runtimeconfig /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/Test.runtimeconfig.json --depsfile /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/Test.deps.json /home/REDACTED/work/REDACTED/REDACTED/src/Test/bin/Debug/net8.0/testhost.dll --port 33609 --endpoint 127.0.0.1:033609 --role client --parentprocessid 4147 --telemetryoptedin false
(http block)If you need me to access, download, or install something from one of these locations, you can either:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.