docs

Documentation

Important

This documentation applies to quick-conf v1.3.0-rc.0.

Tip

Looking for the documentation for your version? You can always find the documentation matching your installed version by clicking the version number in the footer of your own website instance.
This will take you directly to the correct documentation index on GitHub for your specific version.

Welcome to the quick-conf documentation. This index guides you through the available resources, categorized by your role.

👥 For Users (Event Organizers & Agencies)

Guides for setting up, customizing, and managing your conference website.

• Get Started & Setup (template-usage.md)
  • Installation, requirements, and deployment.
• Community Showcase (usage.md)
  • See other conferences using this template.
• Customizing the Landing Page (landing-page-blocks.md)
  • How to use and configure the modular landing page blocks.
• Display Mode Usage (display-mode.md)
  • Quick setup guide for the /display signage page and shareable settings URL.
• Using Icons (icon-usage.md)
  • Guide to the available icon sets and how to use them in content.
• SEO Features (seo.md)
  • Configuration for Sitemap, Robots.txt, and Meta Tags.

---

💻 For Contributors (Developers)

Technical documentation for developers wanting to modify the template code or contribute to the project.

• Local Development Setup (developer-setup.md)
  • Setting up your dev environment.
• Git Conventions (git-conventions.md)
  • Branching model, commit messages, and PR guidelines.
• GitHub Workflows (github-workflow-conventions.md)
  • Understanding the CI/CD pipelines and automation.
• Code Quality (lint-and-prettier.md)
  • Linting, formatting, and style guides.
• Migration Guides
  • Instructions for upgrading between major template versions.