How alzubair98/altinbas-conference works
Project type and purpose
• This is a static, single‐page (plus an “about” page) conference information website built purely with HTML, CSS and vanilla JavaScript.
• It’s hosted on GitHub Pages and includes a simple CI step (HTML/CSS/JS linting) via GitHub Actions.
File structure
• Top-level:
• .github/workflows/linters.yml — defines CI linting checks
• .hintrc — HTMLHint configuration
• index.html, about.html — the two static HTML entry points
• style.css — global stylesheet
• js/index.js — client-side behavior (e.g., navigation, form handling)
• images/ — asset directory for project screenshots and conference graphics
• No backend code, no database, no API layers—purely client‐side.
README
• Confirms it’s a static showcase site for “Altinbas Conference 2022.”
• Built With: HTML, CSS & JS.
• Live demo on GitHub Pages.
• Contributing via GitHub issues; MIT license.
Detail is key
• Even for a simple static site, capture the CI step, the hosting layer, and the asset delivery path.
• Call out configuration files (.hintrc, linters.yml) in the CI component.
• Don’t omit the version control and deployment flow—those are essential architectural elements.