ehmatthes / ehmatthes/cs_standards

Auto-generate separate documents for each level

Open
#2 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

One of my long-term goals is to build a collaborative editing tool that facilitates building and maintaining education standards. You can see an early attempt at [Open Competencies](http://opencompetencies.org). Until that tool is more polished, it might be beneficial to write a quick script that parses the main cs_standards.md file, and automatically generates smaller documents for the individual focus areas, and perhaps for each competency area as well. It's an easy script to write, and may be easier to work with.

Must make it clear no one should spend time manually editing those documents.

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

Start with cs_standards.md and inspect the repository's current document structure to determine the focus-area and competency-area boundaries. Build a script that generates the smaller documents and clearly marks them as generated rather than manually editable; done means the documents can be regenerated consistently from the main file.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.