Support `:api:` tag directive
Open
Nobody has claimed this yet.
Feature Request
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
Possible options:
- public
- private
- protected
Option 1:
- Provide support for tags
- Let plugin generators handle markup
Option 2:
- Provide support for tags
- Implement markup for darkfish
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by investigating the existing tag-directive support and plugin generator behavior, then compare the two proposed options: generator-provided markup or Darkfish-specific markup. Clarify how public, private, and protected should be represented and which documentation generators must support them. Done means the design is decided and the selected implementation works consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100