-
Notifications
You must be signed in to change notification settings - Fork 1
fix: normalize config authoring quirks #873
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
c9e12a3
docs: design workflow ecosystem docs
intel352 cc964f0
docs: review workflow docs ecosystem design
intel352 30f400b
docs: plan workflow docs ecosystem
intel352 b97ae44
docs: review workflow docs ecosystem plan
intel352 1305a76
chore: lock scope for workflow docs ecosystem
intel352 6fb793f
fix: accept http server port alias
intel352 57fde76
fix: normalize db step config aliases
intel352 72d8b53
fix: add pipeline authoring aliases
intel352 3b84e5d
docs: remove config quirks guide
intel352 ce222ae
fix: address config alias review
intel352 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # 0048. Generate Go API Docs With wfctl | ||
|
|
||
| **Status:** Accepted | ||
| **Date:** 2026-06-07 | ||
| **Decision-makers:** workflow maintainers | ||
| **Related:** docs/plans/2026-06-07-workflow-docs-ecosystem-design.md | ||
|
|
||
| ## Context | ||
|
|
||
| The public website already syncs Workflow and plugin Markdown, but it does not | ||
| publish Go API references for Workflow packages or plugin packages. The API | ||
| reference needs released-version awareness, registry-driven plugin discovery, | ||
| and Go package parsing. The website is a renderer and release surface; Workflow | ||
| already owns `wfctl`, plugin contracts, registry metadata, and Go package | ||
| semantics. | ||
|
|
||
| ## Decision | ||
|
|
||
| We will put Go API extraction in `wfctl docs generate` and let | ||
| `gocodealone-website` call that command during docs sync. The generator uses Go | ||
| toolchain and stdlib package documentation APIs, emits Markdown plus version | ||
| metadata, and reads the registry snapshot to discover public plugin repos. | ||
|
|
||
| Rejected alternatives: website-only Node generation would scatter Go package | ||
| rules into the renderer repo; linking only to pkg.go.dev would not provide a | ||
| coherent Workflow ecosystem reference or version navigation. | ||
|
|
||
| ## Consequences | ||
|
|
||
| - The docs pipeline dogfoods `wfctl` and stays Go-native for Go semantics. | ||
| - Website sync gains a Go/wfctl dependency but remains mostly renderer logic. | ||
| - Versioning and plugin fallbacks can be tested at the CLI layer. | ||
| - If generation breaks, website can keep last committed docs while `wfctl` | ||
| reports per-repo warnings. |
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.