Getting Started

Kom igång / Getting Started

This guide helps you set up local access to Vulcan documentation and start creating feature specifications.

Prerequisites / Förutsättningar

You'll need:

Git installed on your computer
Node.js (version 18 or higher)
A text editor (VS Code recommended)
GitLab access to the vulcan-docs repository

Setup / Installation

1. Clone the Repository

bash

git clone git@gitlab.hantverksdata.se:vulcan/vulcan-docs.git
cd vulcan-docs

2. Install Dependencies

bash

npm install

3. Start Local Server

bash

npm run docs:dev

The documentation will be available at http://localhost:5173

Once running, you can:

Section	What you'll find
Product → Context	Product vision, modules, personas, workflows
Product → Templates	Ready-to-use specification templates
Product → Guide	This guide and related how-tos
Product → Glossary	Swedish-English term translations

Your First Spec / Din första specifikation

Read the context - Start with Vision and Modules
Choose a template - Pick from Feature Spec, User Story, or Improvement
Create your file - Save to docs/product/specs/your-feature-name.md
Write your spec - Fill in the template (Swedish or English)
Submit for review - See Submitting Guide

Getting Help / Få hjälp

Claude Desktop: Use AI to help structure your thoughts - see Using Claude
Glossary: Look up Swedish-English terms in the Glossary
Team: Reach out to the development team on Slack

Next Steps / Nästa steg

Writing Specs - Best practices for specifications
Using Claude - AI-assisted specification writing
Submitting - How to submit your spec for review