prototype selection mechanism for different (combined) DocC archive collections
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 5
- Avg merge
- 18h 33m
- Merged PRs (30d)
- 18
Description
Page URL
https://docs.swift.org/latest/documentation/
Description
We've explored this some previously - there's prior art with how the Swift Package Index handles navigating between public DocC archives - that enables some version selection options that are wrapped around how DocC presents it's content, allowing you to switch to and see alternate versions.
Today we have latest (built for 6.4) and main (nightly main development) - and in the future we'll have more release branches, including an explicit /6.4/ url slug version for when latest moves forward
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 at https://docs.swift.org/latest/documentation/ and review how the Swift Package Index navigates between public DocC archives. Define a prototype for selecting among combined archive collections that supports the current latest and main views and the future explicit /6.4/ version URL.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100