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

chore: update template examples for clarity and accuracy #86

Merged
merged 18 commits into from
Dec 1, 2024

Conversation

42atomys
Copy link
Member

@42atomys 42atomys commented Nov 27, 2024

Description

This pull request update all documentation examples and add a tool to validate each documentation examples on CI to prevent any error on documentation since now.

Changes

  • Add a tool task test-doc to test all documentation examples to validate the synthax and the output. Act as second e2e testing.
  • Validate and update all examples according to the result of the docvalidator.

Fixes #78

Checklist

  • I have read the CONTRIBUTING.md document.
  • My code follows the code style of this project.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have updated the documentation accordingly.
  • This change requires a change to the documentation on the website.

@42atomys 42atomys self-assigned this Nov 27, 2024
@42atomys 42atomys linked an issue Nov 27, 2024 that may be closed by this pull request
1 task
Signed-off-by: Atomys <contact@atomys.fr>
Copy link

codecov bot commented Nov 27, 2024

Codecov Report

Attention: Patch coverage is 92.04545% with 21 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
tools/docvalidator/main.go 85.2% 14 Missing ⚠️
tools/docvalidator/filesystem.go 0.0% 4 Missing ⚠️
tools/docvalidator/parsing.go 97.5% 2 Missing and 1 partial ⚠️
Files with missing lines Coverage Δ
pesticide/template_test_helpers.go 100.0% <100.0%> (ø)
tools/docvalidator/processing.go 100.0% <100.0%> (ø)
tools/docvalidator/parsing.go 97.5% <97.5%> (ø)
tools/docvalidator/filesystem.go 0.0% <0.0%> (ø)
tools/docvalidator/main.go 85.2% <85.2%> (ø)

42atomys and others added 2 commits November 27, 2024 22:06
Co-authored-by: ccoVeille <3875889+ccoVeille@users.noreply.github.com>
Signed-off-by: Atomys <contact@atomys.fr>
42atomys and others added 5 commits November 30, 2024 01:41
Co-authored-by: ccoVeille <3875889+ccoVeille@users.noreply.github.com>
Signed-off-by: Atomys <contact@atomys.fr>
…-sprout/sprout into chore/resolve-issues-on-doc-with-a-ci
@42atomys 42atomys requested a review from ccoVeille November 30, 2024 01:14
@42atomys
Copy link
Member Author

@ccoVeille I remove time hack according to #94

@42atomys 42atomys force-pushed the main branch 7 times, most recently from bc836ff to 996df28 Compare November 30, 2024 03:00
@42atomys 42atomys force-pushed the main branch 2 times, most recently from 8158f69 to d42c82a Compare November 30, 2024 03:23
@42atomys 42atomys added the priority/high 🟧 Priority 2 - Stalls work on the project or its dependents label Nov 30, 2024
42atomys and others added 3 commits November 30, 2024 13:24
Co-authored-by: ccoVeille <3875889+ccoVeille@users.noreply.github.com>
Signed-off-by: Atomys <contact@atomys.fr>
Co-authored-by: ccoVeille <3875889+ccoVeille@users.noreply.github.com>
Signed-off-by: Atomys <contact@atomys.fr>
@42atomys 42atomys enabled auto-merge (squash) December 1, 2024 03:44
@42atomys 42atomys merged commit a515b42 into main Dec 1, 2024
14 checks passed
@42atomys 42atomys deleted the chore/resolve-issues-on-doc-with-a-ci branch December 1, 2024 03:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority/high 🟧 Priority 2 - Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: Not all documentation examples work
3 participants