Skip to content

Conversation

@a-zw
Copy link

@a-zw a-zw commented Oct 31, 2025

This creates an initial documentation for the reference_integration by pulling in the documentation of all other modules. This approach was decided in DR-004-Infra: Bi-directional traceability in docs.

Pulls in platform, docs_as_code, and process documentation.

load("//:full_docs.bzl", "all_docs")

all_docs(
Copy link
Member

Choose a reason for hiding this comment

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

I disagree with having a separate command here. Let's see how we can merge POC1 and POC2 next week.

@a-zw a-zw marked this pull request as draft October 31, 2025 12:07
@a-zw
Copy link
Author

a-zw commented Oct 31, 2025

Declaring this as draft until PR #10 is merged.

@a-zw
Copy link
Author

a-zw commented Nov 3, 2025

The current state of this branch separates the "full" build from the "normal" build. Normal would be some reference integration documentation just like any other git repository. The "full" build is just a collection of other documentation builds with a generated index.

This keeps everything simple but the tradeoff is that integration has two kinds of documentation.

@FScholPer
Copy link
Contributor

@a-zw @AlexanderLanin Tomorrow is release day so we should decide soonish

@AlexanderLanin
Copy link
Member

we've implemented a different solution in docs-as-code 2.0.0, which we are currently rolling out to all repos.

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.

4 participants