Skip to content

Add language guide code to repository w/ tests #300

@vados-cosmonic

Description

@vados-cosmonic

Currently, it's possible for code that is in the language guides to be broken/out of date and go unnoticed.

In an ideal world, we'd have some sort of automated process that actually went through the guide and tried to perform all the setup as a new user (maybe AI can do this in the future), but for now, we can get most of the way there by:

  1. Having all the code listings inserted from files (via markdown includes)
  2. Add CI for building the examples for every language

This would do a lot to ensure that we can't add code to guides that doesn't work.

It would be ideal if we could also include chunks of files via markdown (maybe there's a mdbook plugin for that?), but even if we only include full file listings it's still beneficial.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions