docs(zsh-lint): add generated-reference markers#755
Merged
Conversation
Re-add the {/* zsh-lint:generated:start/end */} markers to the Zsh Lint
ecosystem page so the wiki-docs-sync pipeline from z-shell/zsh-lint has a
region to inject into. Seed the region with the current generated Go
reference so the first automated sync is a no-op rather than a failure.
The marked region is machine-managed — do not hand-edit; it is regenerated
from the repo's Go doc comments.
Deploying zsh with
|
| Latest commit: |
3e9d058
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7187e2d7.zsh.pages.dev |
| Branch Preview URL: | https://feature-zsh-lint-docs-marker.zsh.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
Restores the zsh-lint:generated:start/end markers on the zsh-lint ecosystem page and seeds the generated region with the current Go API reference so the wiki-docs-sync workflow in z-shell/zsh-lint can inject updates without failing.
Changes:
- Add a “Reference” section containing
zsh-lint:generated:start/endmarkers. - Seed the marked region with the current
gomarkdoc-generated package reference.
Comment on lines
+45
to
+49
| # zsh\-lint | ||
|
|
||
| import "github.com/z-shell/zsh-lint/cmd/zsh-lint" | ||
|
|
||
| Command zsh\-lint surveys Zsh files with the mvdan/sh parser front end and reports parse success or failure per file \(reboot parser\-evaluation phase, issues \#5, \#8\). Lint rule diagnostics \(issue \#18\) build on this foundation. |
Comment on lines
+55
to
+59
| # survey | ||
|
|
||
| import "github.com/z-shell/zsh-lint/internal/survey" | ||
|
|
||
| Package survey runs the parser front end across a set of Zsh files and reports, per file, whether parsing succeeded. It produces greppable \`path:line:col: message\` diagnostics for failures and a one\-line summary. |
|
|
||
| ## Index | ||
|
|
||
| - [func Run\(names \[\]string, w io.Writer\) int](#Run) |
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.
Summary
Re-adds the
{/* zsh-lint:generated:start/end */}markers to the Zsh Lintecosystem page and seeds the region with the current generated Go reference.
This is the missing piece for the
wiki-docs-syncworkflow inz-shell/zsh-lint: that job runsgomarkdoc→wikidocand injects the result between these markers, thenopens a PR here. Without the markers the inject step errored
(
wikidoc: start marker ... not found). Seeding the region means the firstautomated sync is a no-op diff rather than a failure.
The marked region is machine-managed — do not hand-edit; it is regenerated
from the repo's Go doc comments.
Test plan
wikidocinject ran clean against this page (exit 0)@mdx-js/mdxv3 compile passes