docs: fix review findings (TOC, prerequisites order, phantom tutorial, CI checks, license headers, Ruff rules)#48
Merged
Conversation
- README: add table of contents - README: move Prerequisites before Install opcli commands - README: remove phantom 'opcli tutorial' command (not implemented) - README: fix virtual backends description (tutorial type not implemented) - AGENTS.md: add license header requirement as constraint #7 - AGENTS.md: add codespell, license-check, shellcheck to CI enforcement table - AGENTS.md: add codespell to quick-start commands - AGENTS.md: fix Ruff rule set (was incomplete; now references pyproject.toml) - AGENTS.md: remove tutorial from virtual backend type values Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Applies fixes identified by a UX and technical documentation review.
README.md
spread(installed viaopcliafter opcli itself)opcli tutorialcommand — not implemented; was actively misleadingtutorialbackend type is also not implemented; removedAGENTS.md
.pyfile needs the Apache header; CI enforces viaskywalking-eyescodespell,license-check(skywalking-eyes),shellcheckcodespellto quick-start commands so agents run it before pushingpyproject.tomlwith accurate rule group listtutorialfrom virtual backend type values — not implementedCo-authored-by: Copilot 223556219+Copilot@users.noreply.github.com