spinframework / spinframework/spin-docs

Consider using Promptless for keeping code snippets up to date in docs

Open
#147 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
JavaScript
Stars
6
Forks
23
Avg merge
1d 11h
Merged PRs (30d)
9

Description

I met Frances at KubeCon from Promptless who may be able to help keep the code snippets of our docs up to date and tested in Ci/Cd @frances720

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or tests; start by reviewing how the docs' code snippets are currently maintained and tested in CI/CD. Investigate whether Promptless can provide the proposed workflow, including the role of @frances720. Done should mean the approach is agreed and the snippets are kept up to date and tested automatically.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.