Skip to content

docs: document GitHub Actions workflows - #2184

Open
mackenziereading19 wants to merge 1 commit into
MobilityData:masterfrom
mackenziereading19:1247-document-github-workflows
Open

mackenziereading19 wants to merge 1 commit into
MobilityData:masterfrom
mackenziereading19:1247-document-github-workflows

Conversation

@mackenziereading19

Copy link
Copy Markdown
Contributor

Summary

  • add a central docs/WORKFLOW.md overview for the repository's current GitHub Actions workflows
  • group workflows by CI/validation, packaging/publishing, web deployment, and repository maintenance
  • link existing detailed documentation where applicable
  • add README navigation to the new workflow guide

The original issue predates several of the repository's current workflows, so this documents the present workflow set rather than only the workflows named when the issue was opened.

Validation

  • all 16 current files in .github/workflows/ are referenced in the new guide
  • local Markdown link targets were checked
  • git diff --check passes
  • documentation-only change; no production code changed

Fixes #1247

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document workflows in a new WORKFLOW.md file

1 participant