adobe / adobe/hyde

Auto-generate the file-level documentation from its contents

Open
#96 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
340
Forks
45
PR merge metrics
No merged PRs in 30d

Description

The brief and owner fields in `index.md` for a class and the file that contains it should be inherited (somehow) from the class documentation itself. When there's a single class in a file, it seems silly to copy the brief and owner up to the index file(s).

Another option would be to make those fields `__OPTIONAL__` if there's a single sub-entity in the file. No need to copy if it's just going to be redundant.

Contributor guide

Open the contributing guide

Research direction

Start by tracing how the brief and owner fields are currently represented in class documentation and copied into each file's index.md. Compare the single-class case with files containing multiple sub-entities, then define how inherited or optional fields should behave and what documentation output should confirm the change.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, jekyll
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.