Skip to content

docs: replace raw HTTP examples with supported clients - #348

Merged
mikemcdougall merged 1 commit into
trunkfrom
agent/docs-no-curl-101
Aug 13, 2026
Merged

docs: replace raw HTTP examples with supported clients#348
mikemcdougall merged 1 commit into
trunkfrom
agent/docs-no-curl-101

Conversation

@mikemcdougall

Copy link
Copy Markdown
Contributor

Part of honua-migrate#101. Uses the supported Honua JS CLI for sync verification, clarifies the Fulcrum adapter gap, and makes conformance downloads helper-only. Checks: maintained-doc scan and diff check. Mobile build intentionally not run for docs-only changes.

@github-actions

Copy link
Copy Markdown

📱 Mobile SDK PR Validation

⚠️ Recommendations for Mobile SDK

⚠️ Offline/sync changes - Consider documenting offline behavior impact

📚 Mobile SDK PR Guidelines

  • Use semantic commits: mobile:, sdk:, feat:, fix: etc.
  • Document platform-specific impacts and testing
  • Include breaking changes section for API changes
  • Consider offline/sync implications for field use
  • Test cross-platform compatibility when possible

Automated validation for Honua Mobile SDK

@mikemcdougall

Copy link
Copy Markdown
Contributor Author

CI triage: all change-related validation and the full Mobile CI matrix are green except the still-running Android smoke. The separate Live Server Integration failure is unrelated to these documentation-only files: it runs against honuaio/honua-server:nightly and failed 8 of 11 server contracts (missing mobile_offline_demo across gRPC/OGC, replica licensing returned 402, routing returned 500). Recent trunk runs of this workflow are also failing (for example runs 28393041269 and 28334419666). No server-contract or test suppression is included in this PR.

@mikemcdougall
mikemcdougall marked this pull request as ready for review August 13, 2026 19:03
@mikemcdougall
mikemcdougall merged commit 4a356a8 into trunk Aug 13, 2026
22 of 23 checks passed
@mikemcdougall
mikemcdougall deleted the agent/docs-no-curl-101 branch August 13, 2026 19:04

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 280f861ab8

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .github/workflows/ci.yml
Comment on lines +46 to +47
run: |
if git grep -n -i -w curl -- '*.md' '*.mdx' '*.rst' '*.txt'; then

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Limit the policy check to maintained documentation

Restrict this scan to actual documentation paths and command examples. Git's git grep -h states that -i performs case-insensitive matching and -w matches at word boundaries, while these unrestricted globs include non-documentation artifacts such as tests/Honua.Migrate.Maui.Tests/Fixtures/*.cs.txt; consequently, an unrelated fixture or explanatory paragraph containing the word “curl” will fail the entire changes job even when it provides no raw HTTP workflow.

Useful? React with 👍 / 👎.

Comment on lines +57 to +59
Use Fulcrum's supported export workflow to download the form definition and
records as `fulcrum_forms.json` and `fulcrum_records.json`. Keep attachments in
the export directory so the later import can preserve their relative paths.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Do not promise unsupported attachment preservation

Remove this preservation claim or document a real attachment-import step. A repository-wide search finds no Fulcrum importer consuming these files, and the later sample only submits feature edits while translating photos into URL-shaped values; therefore, when a Fulcrum export contains attachment files, keeping them beside the JSON does not cause the illustrated migration to upload or preserve them and can leave users believing their media was migrated.

Useful? React with 👍 / 👎.

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