Pin Read the Docs builds and versions to stop docs drift
Pin the build environment in readthedocs.yml and map repository tags to Read the Docs versions to keep documentation reproducible and aligned with releases.
Loading…
ReadMeFeed / Community knowledge
#versioning
Real questions. Useful conversations. Find the people who know your stack.
readthedocsServing Versioned Docs with Read the Docs: A Practical Guide to Tag‑Based Releases
Learn how to automatically publish documentation for each Git tag using Read the Docs, see a step‑by‑step example, and understand the trade‑offs of keeping many versions active.
gitManaging Multiple Product Releases with GitBook’s Built‑In Versioning
Learn how to use GitBook’s built‑in versioning to publish docs for each product release, with a concrete workflow, trade‑offs, and verification steps.
gitbookGitBook Public Space Draft Version Access Constraint
Goal: Prevent public access to draft versions in a GitBook space When a GitBook space is configured as public, users can publish a specific version while keeping others as drafts. The platform does not provide a built‑in option to hide those draft URLs from unauthenticated visitors, meaning anyone who knows or guesses the draft link can view the content. Thi
Asset serialization rollback-safety boundaries after Unreal Engine version upgrades
Unreal Engine updates asset file formats and Asset Registry schemas when a project is opened in a newer engine version (e.g., transitioning from 5.3 to 5.4). Because the engine rewrites data upon the first save, assets modified in a newer environment often become incompatible with the previous version's serializer. While FArchive custom versioning and AssetV
unrealengineSphinx version mismatch between local and Read the Docs builds causes inconsistent output
Goal Produce identical HTML output when building a Sphinx project locally and on Read the Docs, despite the platform pinning a specific Sphinx version in its build image. Constraints and uncertainty Read the Docs builds run in a controlled Docker image that includes a fixed Sphinx release (for example, 7.2.x in the current "ubuntu-22.04" image). Local enviro
Increment Major Version vs. Deprecation Message: Choosing a NuGet Strategy for Safe Rollback After a Breaking Schema Change
The goal is to allow consumers of a NuGet package to revert to a non‑breaking version after a breaking schema change without having to manually edit version constraints in their project or lock files. NuGet treats each published version as immutable, so rollback depends entirely on the consumer’s version range and any lock‑file constraints. The documented op
nugetMaintenance branch vs prerelease branch in semantic-release for backporting a fix
Our project uses semantic-release with Conventional Commits, and we need to ship a bug fix to users still on the 1.x line while main has already moved to 2.x. The documented options are a maintenance branch (e.g., 1.x ) that publishes real patch versions, or a prerelease branch (e.g., beta ) that publishes dist-tagged prereleases consumers must opt into. Dur
Devicon and PostCSS integration: class name stability across major versions
When integrating Devicon with a PostCSS‑based build pipeline, the goal is to maintain reliable icon display across project updates without unexpected breakage. Devicon adheres to semantic versioning, where a major release can alter or drop icon class names such as devicon-git-original . PostCSS tools (e.g., cssnano, purgecss) may remove classes that are not
postcss