Skip to content

Add ReadMe Sync Workflow#19

Open
AlejandroLanaspa wants to merge 1 commit into
spaceandtimefdn:mainfrom
AlejandroLanaspa:feat/add-sync-with-readme
Open

Add ReadMe Sync Workflow#19
AlejandroLanaspa wants to merge 1 commit into
spaceandtimefdn:mainfrom
AlejandroLanaspa:feat/add-sync-with-readme

Conversation

@AlejandroLanaspa

Copy link
Copy Markdown

Add ReadMe Sync Workflow

Summary

Automatically sync 3 documentation pages from GitHub → ReadMe using GitHub Actions.

Why This Approach?

Evaluated two options:

Option 1: ReadMe Built-in Git Sync (Bi-directional) ❌

  • Pros: Bi-directional sync (edit in GitHub or ReadMe)
  • Cons:
    • Syncs ALL ReadMe content (~20+ pages) to the repo
    • Creates docs/ folder with duplicate content
    • Adds complexity with _order.yaml files and category folders
    • Mixes code examples with comprehensive documentation

Option 2: GitHub Actions with rdme CLI (One-way) ✅ CHOSEN

  • Pros:
    • Selective sync (only 3 files)
    • Clean repo (one workflow file)
    • GitHub as single source of truth
  • Cons:
    • One-way only (GitHub → ReadMe)
    • Must edit in GitHub, not ReadMe

What This Does

Syncs these 3 files to ReadMe on every push to main:

GitHub File ReadMe Page
how_to/HOW_TO_FUND_SXT_CHAIN_ACCOUNT.md Fund your wallet's SXT Chain account
tutorials/create_hello_world_table/README.md Creating Tables (DDL)
tutorials/onchain_hello_world_query/README.md Queries from a Smart Contract

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