swiftlang / swiftlang/docs

docs migration - LLDB / Debugger

Open
#53 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/lldb/index.md
Proposed disposition: Needs determination — content covers the LLDB debugger and Swift REPL. Could migrate to language-guides/LanguageGuides.docc, to a future compiler-focused catalog, or be deprecated in favor of linking to LLDB's own documentation.
Reviewer: @swiftlang/language-steering-group

Note: The _playground-support.md include file is incorporated into this page and should be handled as part of the same decision.

Checklist

  • Create a GitHub issue to track this migration once destination is confirmed
  • Determine disposition and choose explicit destination
  • Review source content for accuracy against current LLDB and Swift REPL capabilities
  • Decide how to handle the _playground-support.md include content (incorporate inline or as a separate article)
  • Translate Jekyll markdown to DocC markdown format (if migrating)
    • Remove YAML front matter
    • Inline content from _playground-support.md or create a separate article
    • Convert any Jekyll callouts to DocC-style callouts
    • Verify all LLDB command examples against current LLDB release
  • 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

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 by reviewing documentation/lldb/index.md and the included _playground-support.md, then determine the destination with the language-steering-group reviewer. If migration is chosen, translate the content to DocC, add it to the target catalog's Documentation.md, and run swift package generate-documentation --analyze --warnings-as-errors plus the local preview command; completion also requires the source redirect and a swift-org-website PR.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.