Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: TF-M: add TF-M docset wrapper #20809

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

greg-fer
Copy link
Contributor

@greg-fer greg-fer commented Mar 9, 2025

Added wrapper.rst and links.txt for the TF-M docset. NCSDK-32253.


Wrapper preview at https://ncsdoc.z6.web.core.windows.net/PR-20809/tfm/wrapper.html -- the current index won't be replaced until this PR is merged due to server cache.


Next PR will add more information to the wrapper and the links.txt file.

@greg-fer greg-fer added CI-disable Disable CI for this PR doc only labels Mar 9, 2025
@greg-fer greg-fer added this to the 3.0.0 milestone Mar 9, 2025
@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Mar 9, 2025
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Mar 9, 2025

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 16

Inputs:

Sources:

more details

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (0)

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests

Note: This message is automatically posted and updated by the CI

@greg-fer greg-fer force-pushed the doc_tfm_reference_docs_wrapper branch from 1bd58f3 to 01e3fe5 Compare March 9, 2025 15:43
@github-actions github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Mar 9, 2025
@greg-fer greg-fer force-pushed the doc_tfm_reference_docs_wrapper branch 5 times, most recently from e1ad76d to d873855 Compare March 10, 2025 09:22
@greg-fer greg-fer force-pushed the doc_tfm_reference_docs_wrapper branch 4 times, most recently from 33368f2 to 9bfc47a Compare March 24, 2025 13:05
@greg-fer
Copy link
Contributor Author

@gmarull , can you have a look and see what is wrong? I've run out of ideas...

@greg-fer greg-fer requested a review from gmarull March 26, 2025 14:42
Copy link
Member

@gmarull gmarull left a comment

Choose a reason for hiding this comment

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

the problem is that you're adding a new main page that does not reference any of the others, and e.g. old index becomes "orphan". So the "best" you can do is to create a toctree in the wrapper that includes the old main page, but, this will break the original toctree and likely make things worse. Alternatively, you can maintain a noup in our fork of TF-M...

@greg-fer greg-fer force-pushed the doc_tfm_reference_docs_wrapper branch from 9bfc47a to aaf9482 Compare March 27, 2025 13:46
Copy link

You can find the documentation preview for this PR here.

@greg-fer greg-fer force-pushed the doc_tfm_reference_docs_wrapper branch 2 times, most recently from 9f0eb98 to b3ee343 Compare March 27, 2025 16:04
@greg-fer greg-fer marked this pull request as ready for review March 27, 2025 16:05
@greg-fer greg-fer requested a review from a team as a code owner March 27, 2025 16:05
Added wrapper.rst and links.txt for the TF-M docset.
NCSDK-32253.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
@greg-fer greg-fer force-pushed the doc_tfm_reference_docs_wrapper branch from b3ee343 to ffc820f Compare March 28, 2025 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI-disable Disable CI for this PR doc only doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants