Dogfooding: convert a real third-party OSS project's docs into an OKF bundle

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
csharp, markdown, yaml
Domain
cli, documentation

Research direction

Read the README and ROADMAP.md for the OKF bundle conventions and the okf fmt, index, and validate commands. Choose a real third-party OSS project with Markdown documentation, then use those commands to convert and check a bundle. Done means there is a concrete adoption walkthrough based on that project rather than a synthetic sample.

Written by the indexing model from the issue text.

Description

documentation

Extracted from ROADMAP.md (Later).

Convert an existing open-source project's markdown docs into an OKF bundle with okf fmt / index / validate. Publish it as a concrete "here's how you'd actually adopt this" walkthrough rather than another synthetic sample bundle.

Dominant language
C#
Stars
4
Forks
1
Avg merge
1d 4h
Merged PRs (30d)
32

Getting set up

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.

More from jchable/okf4net

All issues in jchable/okf4net

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.