Skip to content

Add GitHub Pages documentation link to README#1

Open
fizamusthafa wants to merge 3 commits into
JaysonBucket:mainfrom
fizamusthafa:main
Open

Add GitHub Pages documentation link to README#1
fizamusthafa wants to merge 3 commits into
JaysonBucket:mainfrom
fizamusthafa:main

Conversation

@fizamusthafa
Copy link
Copy Markdown

Updates the README to include a direct link to the GitHub Pages setup & deployment guide with screenshots, replacing the reference to the PDF that can't keep pace with development.

Changes

Related

  • The \gh-pages\ branch (separate PR) contains the full documentation site built from the PDF content, structured as 6 navigable pages with all screenshots extracted and embedded.

@fizamusthafa
Copy link
Copy Markdown
Author

fizamusthafa commented Feb 16, 2026

Additional: GitHub Pages documentation site

The documentation site lives on a separate \gh-pages\ branch in my fork. Since it's an orphan branch (no shared history with \main), it can't be submitted as a regular PR.

To add the site to your repo:

\\�ash

Fetch the gh-pages branch from the fork

git remote add fizamusthafa https://github.com/fizamusthafa/back2work-with-AI-campaign.git
git fetch fizamusthafa gh-pages
git checkout -b gh-pages fizamusthafa/gh-pages
git push origin gh-pages
git remote remove fizamusthafa
\\

Then go to Settings → Pages and set the source to the \gh-pages\ branch.

The site will be live at: https://jaysonbucket.github.io/back2work-with-AI-campaign/

What the site includes

  • 6 navigable pages with sidebar navigation, search, and the agent logo
  • All 66 screenshots extracted from the PDF
  • Step-by-step instructions matching the PDF content
  • Uses the Just the Docs Jekyll theme (built automatically by GitHub Pages)
  • Mobile-responsive with hamburger menu
image

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