apple / apple/foundationdb

Generate documentation based on fdb.option

Open
#5,719 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
16.7k
Forks
1.6k
Avg merge
1d 20h
Merged PRs (30d)
126

Description

Currently fdb options are manually documented. The document needs to be updated when a new option is added. It would be nice to auto-generated documentation based on the existing code to reduce the toil.

Contributor guide

Open the contributing guide

Research direction

Start by locating fdb.option, the existing code that defines the options, and the manually maintained documentation. Determine how documentation can be generated from that source of truth and how the generated output would be updated when a new option is added. Done means the documentation no longer requires duplicating each option manually.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
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.