Add dedicated documentation page for skip build feature (exit 183) (#12648)
## Documentation Improvement Plan: Skip Build (exit 183) Feature
- [x] Create new dedicated documentation page for skip build feature at
`/docs/user/guides/build/skip-build.rst`
- [x] Write comprehensive documentation covering:
- [x] Introduction and overview of the skip build feature
- [x] How the feature works (exit code 183 explanation)
- [x] When to use skip builds
- [x] Common use cases with examples
- [x] Best practices and limitations
- [x] Update `/docs/user/guides/build/index.rst` to include the new skip
build guide
- [x] Update `/docs/user/build-customization.rst` to reference the new
dedicated page
- [x] Verify documentation builds successfully
- [x] Address code review feedback:
- [x] Fix inverted logic in file type example for clarity
- [x] Improve mathematical explanation of exit code 183
- [x] Address additional review feedback:
- [x] Remove entire "Cancel build based on a condition" section from
build-customization.rst
- [x] Remove extra comments in skip-build.rst examples
- [x] Revert commit message example to original working command
- [x] Simplify environment variables section
- [x] Remove "Test edge cases" section
- [x] Remove "Further reading" section
- [x] Fix broken reference in monorepo.rst
- [x] Remove "Limited to user-defined jobs" section
- [x] Final review and testing
<!-- START COPILOT ORIGINAL PROMPT -->
<details>
<summary>Original prompt</summary>
>
> ----
>
> *This section details on the original issue you should resolve*
>
> <issue_title>Docs: improve "skip build" (`exit 183`)
documentation</issue_title>
> <issue_description>We have this example in our documentation
https://docs.readthedocs.io/en/latest/build-customization.html#cancel-build-based-on-a-condition
that mentions how to cancel a build based on a particular condition.
This is a good example and we have more and more people using it.
>
> However, it does not talk about the feature it self at all. We should
probably create a completely new page for this feature and explain it in
a more in-deep way. We can grab some ideas from "Netlify's ignore
builds" documentation:
https://docs.netlify.com/configure-builds/ignore-builds/</issue_description>
>
> ## Comments on the Issue (you are @copilot in this section)
>
> <comments>
> </comments>
>
</details>
<!-- START COPILOT CODING AGENT SUFFIX -->
- Fixes readthedocs/readthedocs.org#10548
<!-- START COPILOT CODING AGENT TIPS -->
---
💡 You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: humitos <244656+humitos@users.noreply.github.com>
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>