Skip to content

Automate the documentation rendering and publishing? #35

@chriscarrollsmith

Description

@chriscarrollsmith

Since we now have a multi-step workflow for rendering the documentation, it may make sense to automate this. Either with a Makefile alias or, to keep things even cleaner, a Github Actions workflow. It needs to perform these steps:

  1. Run these commands:
quarto publish
quarto render index.qmd --output-dir . --output README.md --to gfm
unlink index.html  # Can skip this step if we add/commit/push only the README rather than all changed files
  1. Add, commit, and push rendered README.md file. (Using, e.g., this push action.)

If we decide to serve a .txt or .cursorrules file for developers using LLMs, then we will also need to render those files in step 1 and add/commit/push them in step 2.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions