Skip to content

feat: add spec, makefile and update the docs for sync summary arch diagram#9

Open
sonupreetam wants to merge 6 commits intocomplytime:mainfrom
sonupreetam:013-sync-summary-arch-diagram
Open

feat: add spec, makefile and update the docs for sync summary arch diagram#9
sonupreetam wants to merge 6 commits intocomplytime:mainfrom
sonupreetam:013-sync-summary-arch-diagram

Conversation

@sonupreetam
Copy link
Copy Markdown
Contributor

@sonupreetam sonupreetam commented Apr 6, 2026

Summary

  • Adds spec, plan, research, and tasks for feature 013-sync-summary-arch-diagram (Hugo shortcode + PNG images for architecture diagrams with dark/light mode support)
  • Updates CONTRIBUTING.md with development workflow guidance
  • Adds Makefile with build, serve, and sync commands for the project
  • Updates README.md and cmd/sync-content/README.md with current tooling info
  • Extends specs/006-go-sync-tool with additional tasks
  • kroki.io is a free public service that intermittently rejects requests from GitHub Actions runners. There are two errorf calls (which abort the build)

Test plan

  • Review spec and plan documents for accuracy
  • Verify Makefile targets are correct for the Hugo + Node.js pipeline
  • Confirm CONTRIBUTING.md instructions are complete and accurate

Signed-off-by: sonupreetam <spreetam@redhat.com>
@sonupreetam sonupreetam requested review from a team and removed request for a team April 8, 2026 07:27
Signed-off-by: sonupreetam <spreetam@redhat.com>
@sonupreetam sonupreetam requested a review from a team April 8, 2026 09:23
@sonupreetam sonupreetam marked this pull request as draft April 8, 2026 09:29
…endency

All mermaid diagram blocks written as `kroki {type=mermaid}` now delegate
to the theme's client-side mermaid renderer instead of POSTing to kroki.io.
This eliminates the build-time dependency on an external free service that
intermittently rejects requests from GitHub Actions runners.

For non-mermaid kroki types, kroki.io is still used but fetch failures are
downgraded from errorf to warnf so CI builds are not broken by network issues.

Made-with: Cursor
… warnings

Two fixes for the doks-core render-codeblock-kroki.html (v1.8.3):

1. output_format "SVG" → "svg": the upstream template sends uppercase which
   kroki.io rejects with HTTP 400 "Bad Request", breaking CI builds.
   Upstream bug: thuliteio/doks-core#106

2. errorf → warnf for network fetch failures: a remote service being
   unreachable is not an authoring error and should not abort the build.

Made-with: Cursor
Signed-off-by: sonupreetam <spreetam@redhat.com>
@sonupreetam sonupreetam removed the request for review from a team April 8, 2026 11:45
Signed-off-by: sonupreetam <spreetam@redhat.com>
@sonupreetam sonupreetam force-pushed the 013-sync-summary-arch-diagram branch from f964b61 to 9c8a484 Compare April 9, 2026 11:02
@sonupreetam sonupreetam marked this pull request as ready for review April 9, 2026 11:06
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