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

CI: detect outdated docs' examples #2532

Open
moul opened this issue Jul 7, 2024 · 2 comments
Open

CI: detect outdated docs' examples #2532

moul opened this issue Jul 7, 2024 · 2 comments
Labels
🗺️good first issue🗺️ Ideal for newcomer contributors

Comments

@moul
Copy link
Member

moul commented Jul 7, 2024

We have gno files in docs/assets/**/*.gno. These files should be tested with CI to ensure the documentation always provides working examples.

Add cd docs; make test.

Example: #2529 (comment)
Related: #2534 (but addressing another similar need)

@moul moul added the 🗺️good first issue🗺️ Ideal for newcomer contributors label Jul 7, 2024
moul added a commit that referenced this issue Jul 7, 2024
- add 'make build' (embedmd)
- refactor Makefile (simplified)
- check on CI that docs/ is "built" (no diff)

Related (but not closing) #2532
Part of #2529

---------

Signed-off-by: moul <[email protected]>
@thehowl
Copy link
Member

thehowl commented Jul 23, 2024

see-also #2357 -- #2245

gfanton pushed a commit to gfanton/gno that referenced this issue Jul 23, 2024
- add 'make build' (embedmd)
- refactor Makefile (simplified)
- check on CI that docs/ is "built" (no diff)

Related (but not closing) gnolang#2532
Part of gnolang#2529

---------

Signed-off-by: moul <[email protected]>
@moul
Copy link
Member Author

moul commented Aug 8, 2024

@aeddi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🗺️good first issue🗺️ Ideal for newcomer contributors
Projects
Status: 📥 Inbox
Status: Triage
Development

No branches or pull requests

2 participants