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

Fix tutorial online doc ToC heading levels #65

Merged
merged 3 commits into from
Jan 6, 2025

Conversation

slawr
Copy link

@slawr slawr commented Jan 3, 2025

Summary

Fixes #64 by updating to the latest Hugo Learn theme version upstream.

Testing

Locally sanity tested the tutorial site to confirm it built, displayed and corrected the bug.

Dev Notes

Rather than manually integrate the updated Learn Theme code I have switched VISSR to add it as a git subtree so future upstream fixes can be more easily added by simply pulling the changes.

Git subtree was used over git submodule as the only current use of submodule is for the optional extended web client. So introducing submodule for a core component would impact how the project must be cloned. Subtree maintains the current behavior of automatically fetching the code. This may also be important for the github actions building the site.

slawr added 3 commits January 3, 2025 17:14
Delete the directory for the Hugo Learn theme used by the online doc
site before adding it back in as a subtree to simplify updates.

Signed-off-by: Stephen Lawrence <[email protected]>
git-subtree-dir: tutorial/themes/learn
git-subtree-split: 3202533a746f91c67de1a8fa373c0328ec1b403d
@slawr slawr added the bug Something isn't working label Jan 3, 2025
@UlfBj UlfBj merged commit ed436f9 into COVESA:master Jan 6, 2025
1 check passed
@slawr slawr deleted the fix-online-doc-toc branch January 6, 2025 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tutorial doc site: Level 3 headings in generated ToC are not indented correctly
2 participants