docs migration - Swift Compiler

Open
#55 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
28/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
swift

Research direction

Start by reviewing documentation/swift-compiler/index.md and the included _compiler-architecture.md content. First coordinate with the compiler team to determine the destination and disposition; completion requires carrying out the selected migration, validation, preview, review, and redirect steps listed in the checklist.

Written by the indexing model from the issue text.

Description

content migration

Source: documentation/swift-compiler/index.md
Proposed disposition: Needs determination — this page covers the compiler's source repository layout and high-level architecture (via _compiler-architecture.md include). The proposal notes the Swift compiler has a userdocs directory that is the right long-term home for compiler documentation. Consider whether this page redirects there, migrates to a catalog in this repository, or retains its current form on swift.org.
Reviewer: @swiftlang/language-steering-group

Note: The _compiler-architecture.md include file is incorporated into this page.

Checklist

  • Create a GitHub issue to track this migration once destination is confirmed (if migrating)
  • Determine disposition and choose explicit destination (coordinate with compiler team regarding the userdocs direction)
  • Review source for accuracy against current compiler architecture
  • Decide how to handle _compiler-architecture.md include content
  • If migrating: translate Jekyll markdown to DocC markdown format
    • Remove YAML front matter
    • Inline content from _compiler-architecture.md or create a separate article
    • Convert any Jekyll callouts to DocC-style callouts
  • If migrating: add article(s) to target catalog's Documentation.md
  • Run swift package generate-documentation --analyze --warnings-as-errors in the target package
  • Preview locally with swift package --disable-sandbox preview-documentation
  • Submit PR for appropriate team review
  • After merge and publication: add redirect_to: in the swift.org source file's front matter
  • Submit redirect PR to swift-org-website
Dominant language
Python
Stars
28
Forks
5
Avg merge
18h 33m
Merged PRs (30d)
18

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from swiftlang/docs

All issues in swiftlang/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.