Generate web documentation with SAP
Open
Nobody has claimed this yet.
chore
- Dominant language
- Swift
- Stars
- 12.4k
- Forks
- 299
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 1
Description
Generate web documentation with SAP.
swift package --allow-writing-to-package-directory generate-docc-reference
Move documentation from README.md to SAP constructs in Swift command files.
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 running swift package --allow-writing-to-package-directory generate-docc-reference and review README.md alongside the Swift command files. Move the applicable README documentation into SAP constructs in those command files, then confirm the web documentation generates successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100