microsoft / microsoft/apm

Docs: align v0.25 guide on UTF-8, experimental apm run, and LSP overview

Open Beginner friendly
#2,315 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/docs-site priority/low status/accepted triage/recommended type/docs
Dominant language
Python
Stars
3.9k
Forks
365
Avg merge
1d 17h
Merged PRs (30d)
132

Description

Affected version

APM CLI 0.25.0 (d73e6ac) and the microsoft/apm/packages/apm-guide#v0.25.0 package.

Verified documentation gaps

  1. The guide presents ASCII-only authoring as a requirement, but current APM parsing and validation support UTF-8 content. Please narrow this to a portability recommendation if that is the intended guidance.
  2. The apm run guidance does not identify the command as experimental, although the installed 0.25.0 CLI exposes it as an experimental surface. Please add the stability caveat so automation does not treat the interface as stable.
  3. The guide overview's target/feature summary omits LSP even though LSP support is documented elsewhere in the same version. Please include LSP in the overview or link to the authoritative LSP section.

Scope note

I independently checked two adjacent claims and am intentionally not reporting them as defects: singular target: is a valid manifest form, and LSP is documented outside the overview. No deployed guide files were modified locally.

Expected result

The v0.25 guide should distinguish requirements from recommendations, label experimental CLI surfaces, and keep the overview consistent with the detailed feature documentation.

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 the microsoft/apm/packages/apm-guide#v0.25.0 guide, checking the overview, UTF-8 authoring guidance, and apm run section against the documented LSP section and the APM CLI 0.25.0 behavior. Done means requirements are distinguished from portability recommendations, apm run is marked experimental, and LSP appears in or is linked from the overview.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.