README: point at the documentation page instead of carrying it - #54
Merged
Conversation
The full reference - both gates rule by rule, --screenshot, --fix, the waivers, the baseline, the config file, the Action, the badges and the library API - now lives at https://abap2ui5.github.io/docs/advanced/linter.html, written for somebody who has not yet decided to use this tool. What stays here is what only makes sense in the repository: the one-line quick start, where the linter runs, how to work on it, and what the generated artefacts are. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YM2A6eh3sX7ssGDuagbSGG
npm test asserted that every rule id appears in the README's finding tables. That gate existed because those tables were hand-written - the one of the five places a new rule moves to that nothing generated. This branch removes the tables, so the gate now guards a duplicate that is gone. What it protected - a rule nobody can look up - is unaffected: RULE_DOCS is the rule prose, and the assertions right above check the registry against it and against the page generated from it, which is stronger than matching ids in a prose table. AGENTS.md follows: a new rule now moves four places, not five. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YM2A6eh3sX7ssGDuagbSGG
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
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.
This README was 843 lines, and it was the only documentation the linter had — which put it in the place a user reaches last, and made it the second copy of everything as soon as the docs site said anything about the tool.
The full reference now lives at https://abap2ui5.github.io/docs/advanced/linter.html: both gates and what each one catches, reading a finding,
--screenshotand the preview-data convention,--fix, the three waiver scopes, the baseline for adopting it on a codebase that already exists, the config file, the GitHub Action, the badges, and the library API — written for somebody who has not yet decided to use this tool.What stays here is what only makes sense standing in the repository:
npm ci, the render runtime as a workspace, and the three generated artefactsnpm testgatesexperimental/disclaimer and the creditsCompanion PR: abap2UI5/docs#156, which adds the page.
🤖 Generated with Claude Code
https://claude.ai/code/session_01YM2A6eh3sX7ssGDuagbSGG
Generated by Claude Code