docs: Integrate docs with Zoomin#147
Merged
markaj-nordic merged 1 commit intoMar 31, 2026
Merged
Conversation
kg-nordicsemi
force-pushed
the
integrate-docs-with-zoomin
branch
from
3cc314e to
3656deb
Compare
kg-nordicsemi
changed the title
There was a problem hiding this comment.
Pull request overview
Adds automation and metadata to build Sphinx documentation and publish it to Zoomin for both “latest” and release-tagged versions.
Changes:
- Add reusable GitHub Actions workflow to build, package, and upload/publish docs to Zoomin via SFTP.
- Add push-based workflows to publish on
maindocs changes and on version tag pushes. - Add docs build script plus Zoomin metadata files (
custom.properties,tags.yml).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
docs/tags.yml |
Introduces Zoomin tag mappings with version placeholders. |
docs/generate_docs.sh |
Adds a helper script to create a venv, install Sphinx deps, and build HTML docs. |
docs/custom.properties |
Adds Zoomin custom properties with version placeholders. |
.github/workflows/publish_documentation.yaml |
Reusable workflow to build docs, zip them, and publish to Zoomin. |
.github/workflows/on_push_tag.yaml |
Triggers publishing on version tags. |
.github/workflows/on_push_publish_documentation.yaml |
Triggers publishing “latest” on main docs changes and manual dispatch. |
Comments suppressed due to low confidence (1)
docs/tags.yml:10
mapping_topics:is currently declared without a value, which YAML parses asnull. If the Zoomin tag mapping expects a mapping/object, this can break processing; set it to an explicit empty map (e.g.,{}) until topic-specific tags are added.
mapping_topics:
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kg-nordicsemi
force-pushed
the
integrate-docs-with-zoomin
branch
3 times, most recently
from
8d89480 to
2b5dec8
Compare
b-gent
requested changes
Mar 30, 2026
Collaborator
b-gent
left a comment
b-gent
left a comment
There was a problem hiding this comment.
please fix CI and move this out of draft
Contributor
|
General comment: to be able to run and test workflows manually GH actions allows to pass a parameter to GH action if needed, you could add a default parameter which specifies where docs should be published to be able to test documentation build. Here is the reference example: 
|
- Add doc_build.yml workflow for building docs, preparing Azure and Zoomin upload artifacts. - Add doc_publish.yml workflow for publishing docs to Azure Storage and Zoomin using SFTP. - Add doc_remove.yml workflow for cleaning up PR preview docs from Azure Storage. - Add _zoomin/aliro.custom.properties and _zoomin/aliro.tags.yml for Zoomin metadata. Signed-off-by: Konrad Grucel <konrad.grucel@nordicsemi.no>
kg-nordicsemi
force-pushed
the
integrate-docs-with-zoomin
branch
2 times, most recently
from
12ef4db to
d756112
Compare
b-gent
approved these changes
Mar 31, 2026
markaj-nordic
approved these changes
Mar 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Uh oh!
There was an error while loading. Please reload this page.