Add docs cross-linking to APIs#571
Merged
llucax merged 2 commits intofrequenz-floss:v0.x.xfrom Aug 9, 2023
Merged
Conversation
Now that the APIs have documentation websites with object inventories, we can configure so proper cross-linking is done and we can easily refer to API objects in the documentation. Signed-off-by: Leandro Lucarella <[email protected]>
For APIs now we can use cross-referencing, which is more user-friendly but also easier to maintain as we only need to update the version we want to point to in one place (the `mkdocs.yml` file). Signed-off-by: Leandro Lucarella <[email protected]>
github-actions
bot
added
part:tooling
llucax
added
type:enhancement
Contributor
Author
|
Enabling auto-merge. |
llucax
added
the
cmd:skip-release-notes
Marenz
approved these changes
Aug 9, 2023
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
2 participants
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.
For APIs now we can use cross-referencing, which is more user-friendly but also easier to maintain as we only need to update the version we want to point to in one place (the
mkdocs.ymlfile).