Host the compiler documentation in swift/docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 5
- Avg merge
- 18h 33m
- Merged PRs (30d)
- 18
Description
Is your feature request related to a problem? Please describe
Currently there is no official website to host the historical out-of-date sphinx documentation.
LLVM and Clang's website is hosting them under /docs/
We had to either read it through some third-party website or clone the Swift repository and manually compile and deploy it for local reading.
Describe the solution you'd like
Hosting them under swift.org/docs website.
Considering some of the docs have been explicitly marked as archive or no longer actively update, we can also consider hosting them to swift.org/archive/docs
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 with the historical Sphinx documentation and the proposed swift.org/docs and swift.org/archive/docs entry points. Determine which archived documents should be hosted at each location, then verify that the published pages are available for reading without local compilation or a third-party site.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100