Project Rules & Guidelines

General Workspace Structure

• Website Root & Build Tooling Separation:
  • Keep Markdown content files (_pages/), site configuration (_config.yml), layouts, styles, collections, and Gemfile in the workspace root for direct editing in Obsidian and seamless GitHub Pages builds.
  • Keep build tooling, Node dependencies (package.json), Python code-generators (source/ -> website/source/), and Playwright visual regression tests (tests/, playwright.config.js) inside website/.
• Obsidian-Friendly Content:
  • Write .md files in _pages/ using standard, native Markdown without raw presentational HTML tags (<div class="...">, inline style="...").
  • Handle card grids, lists, and visual layouts downstream via SCSS (_sass/_custom-design.scss).
• Internal Guidelines Hosting:
  • Host personal academic content (e.g. Student Guidelines at /students/ and Project Types at /prospective/) internally within _pages/ rather than linking out to external Google Sites.

Commands & Tooling

• Local Preview Server: bundle exec jekyll serve (Always run local servers on localhost rather than fixed IP 127.0.0.1)
• Run Visual Regression Tests: cd website && npx playwright test
• Check GitHub Workflows status: gh run list --limit 3

Deployment & Verification

• Production URL: https://matheusvxf.github.io/
• Repository URL: https://github.com/matheusvxf/matheusvxf.github.io
• Deployment Verification Rule:
  • Always wait for GitHub Actions workflows (deploy-pages and visual-regression) to complete and confirm live site status (https://matheusvxf.github.io/) before declaring completion.
• Hyperlink Conventions:
  • Links should open in the current tab (avoid target="_blank").
  • Ensure all hyperlinks are clearly styled with a distinct accent color and underline.