Skip to main content

Tech Stack

This web book is built with Docusaurus, a free and open-source framework. I chose it for its structured document support, versioning capabilities, flexibility, and my familiarity with React.js. The book is hosted and published on GitHub Pages, leveraging free and open-source resources.

1) Setting Up Docusaurus for my Webbook​

npx create-docusaurus@latest programming_with_ai classic
cd programming_with_ai
yarn start

The template is perfect. next let's initiate versioning.

git init

I then need to create a new repository called webbook in Github.

info

Why I called it a Webbook? The ‘web’ ensures accessibility, and the ‘book’ provides structure and practicality. I want this to be a hands-on, highly accessible resource that anyone can apply in their daily work. Instead of just writing theory, I'll build real projects, testing everything I advocate—leading by example.

Now let's commit the current source code into the remote repository hosted on Github:

git add .
git commit -m "init"
git remote add origin git@github.com:miladtsx/webbook.git
git push origin main

Continuous Deployment​

info

Deploying manually is for the past. setup automatic deployment once and forget about deploying forever.

A proper CI/CD pipeline (or automatic deployment) often includes unit/integration tests. However, for this web book, the build process itself serves as a sufficient test. Docusaurus inherently validates links and ensures proper rendering, so dedicated tests are unnecessary for now. We simply ensure that successful builds are automatically published.

Setting up GitHub Actions as our CI/CD infrastructure​

In this commit where I added GitHub Actions configuration, I set up a new GitHub Action to build and publish the site. The functionality is simple: fetch the code, build it, and publish to GitHub Pages when I push something to the main branch.

You can see the result of this action here. The website is live now!

From now on, any push to the main branch will automatically trigger the build and deployment process.

🚨 Important Disclaimer​

In a team setting, you should never push directly to main. Instead, follow a branch-based workflow:

  1. Create a new branch for your changes.
  2. Open a Pull Request (PR).
  3. Another team member reviews and approves the PR before merging into main.

Why This Matters?​

A structured PR-based workflow has major advantages:

✅ Code Quality – A second pair of eyes helps catch issues early.

✅ Safer Deployments – PRs can trigger preview environments to test changes before merging.

✅ Better Collaboration – Everyone stays informed and aligned with the latest updates.

🔗 Learn more about PRs: GitHub Docs.