Repository navigation
Add known issues, quick reference, examples and doc checks - #4
Merged
Merged
Conversation
GitHub drops the class attribute on <p class="callout ...">, so notes, warnings and cautions rendered as plain paragraphs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F9kBF4xCgCfvskpe5rnfw7
- User Name everywhere (was also UserName and Username) - Page titles all read "JHAT Commands: ...", and Intercompany matches HFM's spelling - Script examples use a text code fence rather than dart Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F9kBF4xCgCfvskpe5rnfw7
The Docs workflow runs markdownlint and an offline lychee check of links between pages, including #anchors, on pushes to main and on PRs. Also fixes what the checks found: images now use Markdown with alt text and relative paths, and the two alerts followed by a list now include it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F9kBF4xCgCfvskpe5rnfw7
Collects the JHAT behaviours that hide failures or give wrong results, which were spread across the command pages, with links to each. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F9kBF4xCgCfvskpe5rnfw7
Generated from the @JhatFunction annotations in the decompiled handlers: command, accepted parameter counts, page and first sentence of its description. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F9kBF4xCgCfvskpe5rnfw7
The example loads, consolidates and extracts using a macro file for settings and -M for credentials. Its batch wrapper checks the log's summary, since JHAT's exit code is 0 even when commands fail. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F9kBF4xCgCfvskpe5rnfw7
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
classon<p class="callout ...">, so notes, warnings and cautions showed as plain text. All 265 now use> [!NOTE],> [!WARNING]and> [!CAUTION].docs/known-issues.md): the JHAT behaviours that hide failures or give wrong results, collected from the command pages, with links to each. Covers failure detection (exit code, load/extract status), parameter pitfalls, commands that don't work, commands with wrong results, and side effects.docs/quick-reference.md): all 202 commands with parameter count, page and a one-line purpose. Generated from the@JhatFunctionannotations in the decompiled handlers.examples/): script, macro file, credentials template and a batch wrapper that fails when the log's summary shows execution errors, syntax errors or invalid function names, since JHAT's exit code is 0 either way. Written against the decompiled source; not yet run on a live HFM server.#anchors.User Nameeverywhere, uniform page titles (JHAT Commands: …,Intercompany),textcode fences instead ofdart, screenshots with alt text and relative paths.Testing
markdownlint-cli2 "**/*.md": 0 issueslychee --offline --include-fragments "**/*.md": 0 errors (confirmed it catches a broken anchor)🤖 Generated with Claude Code
https://claude.ai/code/session_01F9kBF4xCgCfvskpe5rnfw7
Generated by Claude Code