swiftlang / swiftlang/docs

docs migration - Configuring Emacs for Swift Development

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

Nobody has claimed this yet.

content migration
Dominant language
Python
Stars
28
Forks
5
Avg merge
18h 33m
Merged PRs (30d)
18

Description

Source: documentation/articles/zero-to-swift-emacs.md
Proposed disposition: Migrate
Proposed destination: ecosystem-tools/Sources/EcosystemTools.docc/zero-to-swift-emacs.md
Reviewer: @swiftlang/ecosystem-steering-group

Checklist

  • Create a GitHub issue to track this migration
  • Determine disposition (suggested: Migrate) and confirm destination
  • Review source for accuracy against current Emacs packages and SourceKit-LSP integration
  • Translate Jekyll markdown to DocC markdown format
    • Remove YAML front matter
    • Convert any Jekyll callouts to DocC-style callouts
    • Verify package installation steps (MELPA, swift-mode, lsp-mode) are current
    • Update any platform-specific version references
  • Add article to EcosystemTools.docc/Documentation.md under an "Editor Configuration" topic group
  • Run swift package generate-documentation --analyze --warnings-as-errors in ecosystem-tools/
  • Preview locally with swift package --disable-sandbox preview-documentation in ecosystem-tools/
  • Submit PR to this repository for ecosystem steering group 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

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.

Research direction

Start with documentation/articles/zero-to-swift-emacs.md and compare its Emacs package and SourceKit-LSP guidance with the current setup. Migrate it to ecosystem-tools/Sources/EcosystemTools.docc/zero-to-swift-emacs.md, update Documentation.md, and run the two listed documentation generation and preview commands. Done includes steering-group review and the post-publication source and redirect PRs.

Written by the indexing model from the issue text.

Assessment

Tech stack
emacs, jekyll, swift
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.