Skip to content

docs: add explanation for the build and how-to for build passthroughs#504

Merged
medubelko merged 3 commits intocanonical:mainfrom
medubelko:docpr-2420-docs-build-bridge
Jan 28, 2026
Merged

docs: add explanation for the build and how-to for build passthroughs#504
medubelko merged 3 commits intocanonical:mainfrom
medubelko:docpr-2420-docs-build-bridge

Conversation

@medubelko
Copy link
Copy Markdown
Collaborator

This is the companion document to #494.


- [ ] Have you updated CHANGELOG.md with relevant non-documentation file changes?

  • Have you updated the documentation for this change?

@medubelko medubelko changed the title docs: add explanation and how-to for build passthroughs docs: add explanation for the build and how-to for build passthroughs Jan 22, 2026
Comment thread docs/how-to/bridge-project-and-doc-builds.rst
Copy link
Copy Markdown
Contributor

@tang-mm tang-mm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice write-up and thanks for documenting the solution! My main suggestion is to clearly state eligibility upfront (as much as we know) to prevent potential build failures in legacy or specialized environments

Comment thread docs/how-to/bridge-project-and-doc-builds.rst Outdated
Comment thread docs/how-to/bridge-project-and-doc-builds.rst
Comment thread docs/how-to/bridge-project-and-doc-builds.rst Outdated
Comment thread docs/how-to/bridge-project-and-doc-builds.rst Outdated
akcano
akcano previously requested changes Jan 22, 2026
Comment thread docs/explanation/build.rst
Comment thread docs/how-to/bridge-project-and-doc-builds.rst Outdated
Comment thread docs/how-to/bridge-project-and-doc-builds.rst
Comment thread docs/how-to/index.rst
@medubelko medubelko requested review from akcano and tang-mm January 23, 2026 01:49
Comment thread docs/explanation/build.rst Outdated
Comment thread docs/how-to/bridge-project-and-doc-builds.rst Outdated
Copy link
Copy Markdown
Contributor

@a-velasco a-velasco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @medubelko!

Comment thread docs/how-to/bridge-project-and-doc-builds.rst Outdated
Comment thread docs/how-to/bridge-project-and-doc-builds.rst
Copy link
Copy Markdown
Contributor

@dwilding dwilding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look great, thanks! On this reading, I spotted a potential issue related to pip version. I'm sorry, I missed this the first time I was looking at the Makefile.

Comment thread docs/how-to/bridge-project-and-doc-builds.rst Outdated
Comment thread docs/how-to/bridge-project-and-doc-builds.rst Outdated
Copy link
Copy Markdown
Contributor

@dwilding dwilding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of minor suggestions - but overall I really like the updated structure and explanations. Nice one!

Comment thread docs/how-to/bridge-project-and-doc-builds.rst Outdated
Comment thread docs/how-to/bridge-project-and-doc-builds.rst Outdated
Comment thread docs/how-to/bridge-project-and-doc-builds.rst Outdated
Comment thread docs/how-to/bridge-project-and-doc-builds.rst
Comment thread docs/how-to/bridge-project-and-doc-builds.rst
@medubelko
Copy link
Copy Markdown
Collaborator Author

@dwilding @a-velasco @tang-mm @akcano Thanks so much for your reviews! You've helped make this a much better doc.

I'm going to PR this against main, so some force-pushes are incoming.

`VALEDIR` represents the package directory for Vale, yet it re-establishes the same path as `VENVDIR`. It makes more sense to compose it from `VENVDIR`.

Furthermore, since `VENVDIR` is configurable by the calling environment, it stands to reason that `VALEDIR` should be, too.
@medubelko medubelko force-pushed the docpr-2420-docs-build-bridge branch from f1a8f7f to 34a64cb Compare January 28, 2026 01:46
@medubelko medubelko changed the base branch from dev to main January 28, 2026 01:46
@medubelko medubelko dismissed akcano’s stale review January 28, 2026 01:47

All comments addressed, GitHub is being difficult.

@medubelko medubelko merged commit ae795f1 into canonical:main Jan 28, 2026
1 check passed
@medubelko medubelko deleted the docpr-2420-docs-build-bridge branch January 28, 2026 01:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants