Skip to content

Repo Template #3

@clemensv

Description

@clemensv

Given #1, we should build a GitHub repository template that has the following:

Minimal model.json and a spec.md for the user(s) to complete. A README.md with instructions for the repo setup, including LLM prompts that can accelerate building a correct model, with the prompts linking specs and examples.

A registry directory that becomes the working directory for collaborative resource management.

A set of GitHub workflows:

  • generate JSON Schema and OpenAPI from the model.json after validation
  • validate additions/changes to the groups and resources under registry
  • build the static site into a branch (eg. gh-pages) and configurable folder layout. Let the user configure a second site source within the repo or an external repo that gets merged with the generated static site like, for instance, a navigation web site.
  • generate a set of compact, flat index files for search (for the static site and other uses). Example: description texts mapped to xid to seed full text search.

The resulting repo is a full static server that can be managed with document PRs or direct check-ins and can run on GH pages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions