swiftlang / swiftlang/docs

docs migration - Configuring Neovim for Swift Development

Open
#68 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-nvim.md
Proposed disposition: Migrate
Proposed destination: ecosystem-tools/Sources/EcosystemTools.docc/zero-to-swift-nvim.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 Neovim plugin ecosystem (lazy.nvim, nvim-cmp, LuaSnip) and SourceKit-LSP
  • Translate Jekyll markdown to DocC markdown format
    • Remove YAML front matter
    • Convert any Jekyll callouts to DocC-style callouts
    • Verify plugin configuration snippets compile and function correctly
    • Update any version-pinned references in plugin configurations
  • 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-nvim.md and compare it with the proposed destination ecosystem-tools/Sources/EcosystemTools.docc/zero-to-swift-nvim.md. Review the Neovim plugin and SourceKit-LSP references, convert the document for DocC, add it to Documentation.md, and run the two listed documentation commands in ecosystem-tools/. Done means the article is validated, previewable, published, and the source redirect PR is prepared.

Written by the indexing model from the issue text.

Assessment

Tech stack
neovim, 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.