FluffyLabs / FluffyLabs/jammin

Add validation for documentation code examples

Open
#108 0 comments 0 reactions 1 assignee Claimed by @tomusdrw View on GitHub
Dominant language
TypeScript
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Context

Ensure that code examples in documentation (especially in testing.md and other docs) compile correctly. This can be achieved either by:
1. Adding a CodeRabbit rule to validate examples
2. Externalizing examples from documentation files so they can be tested as part of the build process

Reference implementation exists in the typeberry project.

## Related
- PR: https://github.com/FluffyLabs/jammin/pull/106
- Comment: https://github.com/FluffyLabs/jammin/pull/106#discussion_r2811545831
- Requested by: @tomusdrw

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.