docs migration - Going Passwordless with Passkeys
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 5
- Avg merge
- 18h 33m
- Merged PRs (30d)
- 18
Description
Source: documentation/server/guides/passkeys.md
Proposed disposition: Migrate
Proposed destination: server-guides/Sources/ServerGuides.docc/passkeys.md
Reviewer: @swiftlang/server-workgroup
Note: The article is tutorial-style and links to an external starter project on GitHub. Verify the starter project is still accessible and maintained before migrating.
Checklist
- Create a GitHub issue to track this migration
- Determine disposition (suggested: Migrate) and confirm destination
- Verify the external starter project (
brokenhandsio/swift-webauthn-guide) is still accessible and up to date - Review source for accuracy against current
webauthn-swiftlibrary API - Translate Jekyll markdown to DocC markdown format
- Remove YAML front matter
- Convert any Jekyll callouts to DocC-style callouts
- Verify all WebAuthn registration and authentication flow steps
- Update links to external resources
- Add article to
ServerGuides.docc/Documentation.mdunder an "Authentication" or "Security" topic group - Run
swift package generate-documentation --analyze --warnings-as-errorsinserver-guides/ - Preview locally with
swift package --disable-sandbox preview-documentationinserver-guides/ - Submit PR to this repository for server workgroup review
- After merge and publication: add
redirect_to:in the swift.org source file's front matter - Submit redirect PR to swift-org-website
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 documentation/server/guides/passkeys.md and compare it with server-guides/Sources/ServerGuides.docc/passkeys.md and the current webauthn-swift API. Verify brokenhandsio/swift-webauthn-guide is accessible and maintained, then migrate and link the article in ServerGuides.docc/Documentation.md. Run the two listed documentation commands; done means the guide builds, previews correctly, and is ready for workgroup review.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100