open-feature / open-feature/cli

Generate feature flag docs from the flag manifest

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

Nobody has claimed this yet.

Dominant language
Go
Stars
63
Forks
22
Avg merge
1h 27m
Merged PRs (30d)
19

Description

Description

The flag manifest file contains information about the current state of the feature flag. It could be used to generate documentation in markdown (and eventually other formats). This could be useful in developer-facing documentation, pull request reviews, and more.

Contributor guide

Open the contributing guide

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, tests, or entry points. Start by locating the flag manifest handling and existing CLI output or documentation paths, then determine how markdown generation should be exposed. Done means the current manifest can produce developer-facing markdown documentation; support for other formats is described as future work.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, 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.