Skip to content

Chore/sync wiki#237

Open
jlouvel wants to merge 2 commits intomainfrom
chore/sync-wiki
Open

Chore/sync wiki#237
jlouvel wants to merge 2 commits intomainfrom
chore/sync-wiki

Conversation

@jlouvel
Copy link
Copy Markdown
Contributor

@jlouvel jlouvel commented Apr 3, 2026

What does this PR do?

Syncs the in-repo wiki content (wiki) with the latest published wiki, aligning it with the v1.0.0-alpha1 release. Two categories of changes:

File renames — Wiki page filenames now use non-breaking hyphens () as separators (e.g. Guide-Use-Cases.mdGuide-‐-Use-Cases.md, Tutorial-Part-1.mdTutorial-‐-Part-1.md) to match the GitHub Wiki URL scheme. Affected files: Specification-Schema, Specification-Rules, Spec-Driven-Integration, Guide-Linting, Guide-Use-Cases, Tutorial-Part-1, Tutorial-Part-2.

Content updates:

  • FAQ — Added new Q&A entry for MCP mock tools with const-valued output parameters (no consumes block required).
  • Guide - Use Cases — Added detailed "Key features" checklists to all 9 use cases, covering authentication, orchestration, output shaping, format conversion, forward proxy, binds, and multi-adapter exposure.
  • Guide - Linting — Fixed internal wiki links to use percent-encoded non-breaking hyphen URLs.
  • Installation — Fixed typos (reffersrefers, carefullcareful), updated tutorial download links to point to the v1.0.0-alpha1 tag on GitHub raw content, and added trailing slash to baseUri example.
  • Releases — Updated 1.0 Alpha 1 row with release link to v1.0.0-alpha1 tag.
  • Tutorial Part 1 — Converted relative file download links to absolute raw GitHub URLs pinned to v1.0.0-alpha1; added download links for shared consumes files; fixed internal wiki cross-links.
  • Tutorial Part 2 — Same link fixes as Part 1; switched Part 1 back-reference to relative wiki link.

Tests

No tests added — documentation-only changes to wiki Markdown files. No Java code modified.


Checklist

  • CI is green (build, tests, schema validation, security scans)
  • Rebased on latest main
  • Small and focused — one concern per PR
  • Commit messages follow Conventional Commits

Agent Context (optional)

agent_name: GitHub Copilot
llm: Claude Opus 4.6
tool: VS Code Chat
confidence: high
source_event: user request to prepare PR message
discovery_method: code_review
# review_focus: src/main/resources/wiki/

@jlouvel jlouvel requested a review from eskenazit April 3, 2026 18:53
@jlouvel jlouvel self-assigned this Apr 3, 2026
@jlouvel jlouvel requested a review from jeremnaf April 3, 2026 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant