Add new checkers to validate documentation and fix all findings - #69
Open
ArekBalysNordic wants to merge 5 commits into
Open
ArekBalysNordic wants to merge 5 commits into
ArekBalysNordic wants to merge 5 commits into
Conversation
Automatically read west.yaml and create documentation with the proper SHA of sdk-conenctedhomeip while building sphinx docs. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
- Check if all links are usable and point to existing items - Check if references work Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
ArekBalysNordic
force-pushed
the
doc_many_fixes
branch
8 times, most recently
from
September 23, 2026 07:24
25a9e73 to
72480ca
Compare
- One workflow will check documentation and the other one samples. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
ArekBalysNordic
force-pushed
the
doc_many_fixes
branch
from
September 23, 2026 07:51
72480ca to
76b2414
Compare
- Add :external: prefix to define that something should be found in the external link. For example, functions and structs from sdk-nrf or Zephyr. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
ArekBalysNordic
force-pushed
the
doc_many_fixes
branch
2 times, most recently
from
September 23, 2026 13:06
1ff3137 to
c9588d4
Compare
Used new tools for checking undefined labels and dead links and fixed all found places where documentation was wrong. Signed-off-by: Arkadiusz Balys <arkadiusz.balys@nordicsemi.no>
ArekBalysNordic
force-pushed
the
doc_many_fixes
branch
from
September 24, 2026 07:08
c9588d4 to
cc7078e
Compare
This branch has not been deployed
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
1 participant
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.
See commit descriptions.