| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
You can ask your AI agent to walk you through any step below, or follow this guide directly. Both paths arrive at roughly the same place. The agent is non-deterministic; this guide is the deterministic path. They do the same thing in spirit.
This is a starter site scaffolded from the GDD gh-pages component template. It deploys to GitHub Pages as-is, lets you exercise the full GDD-and-bot-review workflow with a tiny live target, and is meant to be edited from day one.
After ws component init gh-pages <name> finished, the suggested next step it printed was something like:
gh repo create <yourname>/<name> --public \
--source=components/<name> --remote=<yourname> --pushRun that. It creates a public repo on your GitHub account, sets your username as the remote name (avoids the generic origin), and pushes the initial commit.
Why public? Free GitHub Pages on personal accounts requires a public repo. A private Pages site is paid (GitHub Pro / Team / Enterprise). If you want it private, swap --public for --private in the suggested command and accept the cost on your end.
If you'd rather create the repo by hand:
Go to https://github.com/new while signed in.
Repository name: <name> (matching the directory). Public.
Skip the README / .gitignore / license options — your scaffold already has them.
Click Create repository.
Back in your terminal, set the remote and push:
cd components/<name>
git remote add <yourname> https://github.com/<yourname>/<name>.git
git push -u <yourname> mainGitHub doesn't auto-enable Pages on new repos. You enable it once, manually:
Your site lives at https://<yourname>.github.io/<name>/. Visit it and you should see the placeholder page.
The point of the demo is to feel the full GDD loop — write, propose, review, merge — on a tiny target. The walkthrough below stays in the yggdrasil workspace root throughout (no cd-juggling), since ws operates on components by name from there.
1. Create your topic branch:
git -C components/<name> checkout -b first-post(Branch creation is git's job; ws doesn't wrap it.)
2. Edit the home page. Open components/<name>/index.md in your editor and replace the placeholder paragraph with whatever you want.
3. Write a commit bodyfile. ws commit is bodyfile-driven — every commit declares the files it stages, so there's no separate git add step. Create .commits/first-post.md in the yggdrasil workspace root (the .commits/ directory is gitignored at the workspace level) with this content:
---
message: "Make the home page mine"
add:
- index.md
---
First edit on the new GitHub Pages site.The add: paths are relative to the component, not the workspace root — ws commit cd's into components/<name>/ before staging. The body below the frontmatter becomes the commit message body.
4. Commit and push:
ws commit <name> .commits/first-post.md
ws push <name> first-postws commit stages the listed files, builds the message, and appends a Co-Authored-By trailer. ws push picks the right remote from your identity config.
Like ws commit, ws cr is bodyfile-driven. Copy the change template to .crs/first-post.md in the yggdrasil workspace root (gitignored) and fill in the summary:
cp templates/change.md .crs/first-post.md
$EDITOR .crs/first-post.mdReplace the bracketed placeholder under Summary with one bullet describing the edit, and either keep the Test plan as-is (loading the deployed site is the test) or trim it. The @HUMAN_ACCOUNT / @GDD_HOME markers in the body are substituted at CR-creation time from your identity config.
Open the PR:
ws cr <name> "Make the home page mine" .crs/first-post.mdws cr picks the right remote from your identity, runs the underlying gh pr create, and prints the PR URL.
Now wait for the reviewers:
You'll see review threads appear inline in the diff. CodeRabbit's review tends to be detailed; for a one-paragraph change it might just suggest a wording tweak or note that everything looks fine.
Once you're happy with the review thread responses (or there's nothing to address):
That's the whole loop.
The template stays minimal so you can take it where you want. A few common next steps:
The component is registered in your workspace's ecosystem.local.yaml under components.<name> so ws status, ws push <name>, ws log <name>, etc. all work from the yggdrasil root. To share this component with your community, move that ecosystem.local.yaml entry into your realm's ecosystem.yaml with realm-appropriate fields (tier, etc.) and push the realm.
| Back | FazBrowse Home | New Git URL |