Skip to main content
Docusaurus Logo

Assignment Overview

Your task is to create project documentation using Docusaurus and host it publicly on GitHub Pages.

Setting Up the Project

Click the button below to join GitHub Classroom and create your team.

Create GitHub Team 🐙

Step 1: Join GitHub Classroom​

  1. Click here to join the GitHub Classroom and get the starter project.
  2. Log in to your GitHub account or create one at GitHub.
  3. Select your name and TUmail from the list.
  4. Join your team or create a new one if none exists.

Step 2: Configure the GitHub Build Environment​

One team member must complete this setup:

  1. Enable GitHub Actions:
  • Go to the Actions tab in your repository → Enable workflows if prompted.
  1. Make an initial commit to trigger the workflow:
  • Each team member should add their name to the ## Collaborators section in the README.md file and commit this change.
  • This will trigger GitHub Actions to build and deploy your site to the gh-pages branch using the workflow in .github/workflows/deploy.yml.
  • Wait for the workflow to complete successfully (you'll see a green checkmark in the Actions tab).
  1. Enable GitHub Pages (after the workflow completes):
  • Navigate to the repository → Settings → Pages.
  • Under "Source", select Deploy from a branch.
  • Select gh-pages as the branch and / (root) as the folder.
  • Note: The gh-pages branch will only be available after the GitHub Actions workflow has run successfully at least once.
  1. View Your Website:
  • After GitHub Pages is configured, your site will be available at: https://capstone-projects-YEAR-SEMESTER.github.io/project-PROJECT-NAME/
    • For example: https://capstone-projects-2025-spring.github.io/project-acc-hungry-hippos/

Step 3: Repository Setup​

  1. Each team member should make their initial commit:
    • Add your name to the ## Collaborators section in the README.md file
    • Commit and push this change as your first contribution to the project
Quick Git Refresher

How to Add Yourself as a Collaborator in Git

Option 1: GitHub Web Interface (Easiest)

  1. Navigate to your repository on GitHub
  2. Open README.md → Click the pencil icon (✏️) to edit
  3. Find the ## Collaborators section and add your name
  4. Scroll down, add commit message: "Add [Your Name] to collaborators"
  5. Click "Commit changes"

Option 2: Git Command Line Clone and navigate to repository

git clone [your-repository-url]
cd [repository-name]

Edit README.md (add your name to ## Collaborators section) Then commit your changes

git add README.md
git commit -m "Add [Your Name] to collaborators"
git push origin main

Need more help with Git?

  1. Edit the README.md file:
    • Add a project overview at the top
  2. Lock the main branch:

Submission Instructions​

  • Submit the link to your team’s docusaurus website after all members have joined.
  • Ensure all documentation requirements are complete.

Grading​

  • This is a group assignment.
  • Graded as Complete/Incomplete.
  • Incomplete submissions will be invited for resubmission until all requirements are met.

Need Help?​

For questions or assistance, reach out to your instructor or teaching assistant.