Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/apursley2012/developer-dossier/llms.txt

Use this file to discover all available pages before exploring further.

Developer Dossier is a fully static Vite build. Running npm run build produces a dist/ directory containing all HTML, JavaScript, CSS, and asset files. That directory can be dropped onto any static hosting provider — no Node.js server, no serverless functions, and no database required. If a host can serve an index.html file, it can serve Developer Dossier.

​
Build Command

Run the following from the project root to produce the production bundle: 
npm run build
The dist/ directory will contain:
File / DirectoryDescription
index.htmlRoot entry point served for all requests
assets/main.jsBundled React application
assets/main.cssCompiled Tailwind CSS
assets/jsx-runtime.jsReact JSX runtime
assets/proxy.jsFramer Motion proxy module
components/casefile/*.jsIndividual component modules
data/*.jsContent data modules
pages/*.htmlStatic route shells

​
Why No Server Rewrites Are Needed

Developer Dossier uses hash-based routing. Every route is expressed as a hash fragment — #/about, #/projects, #/writing/art-001 — rather than a real URL path. When a user navigates to /#/projects, the browser only sends / to the server; the #/projects fragment is handled entirely in the browser by React Router. Every request therefore hits index.html, and the correct page renders client-side. This means there is no need for a _redirects file (Netlify), a vercel.json rewrite rule, or any equivalent server-side configuration on other hosts.
The only exception is if you want to enable pretty direct-URL access for the static HTML shells in pages/. For example, navigating directly to /data/about.html works because that file exists on disk — but this is optional and not required for normal portfolio browsing.

​
Netlify

1

Push your repository to GitHub

Make sure your latest code (including any content edits) is pushed to a GitHub repository.
2

Create a new Netlify site

Log in to netlify.com, click Add new site, and choose Import an existing project.
3

Select your repository

Authorize Netlify to access GitHub and select your Developer Dossier repository.
4

Configure build settings

Set Build command to npm run build and Publish directory to dist.
5

Deploy

Click Deploy site. Netlify will build the project and publish it. From this point on, every push to your default branch triggers an automatic rebuild and redeploy.

​
Vercel

1

Push your repository to GitHub

Ensure your latest changes are committed and pushed.
2

Import the project in Vercel

Log in to vercel.com, click Add New → Project, and import your GitHub repository.
3

Confirm the build configuration

Vercel auto-detects Vite projects. Confirm that Build command is npm run build and Output directory is dist. No other settings need to change.
4

Deploy

Click Deploy. Vercel builds and publishes the site, and future pushes to the main branch redeploy automatically.

​
GitHub Pages

1

Enable GitHub Pages in your repository

In your repository, go to Settings → Pages. Under Source, select GitHub Actions.
2

Create the workflow file

Create the file .github/workflows/deploy.yml in your repository with the following content:
name: Deploy to GitHub Pages
on:
  push:
    branches: [main]
permissions:
  contents: read
  pages: write
  id-token: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm ci
      - run: npm run build
      - uses: actions/upload-pages-artifact@v3
        with:
          path: dist
      - id: deployment
        uses: actions/deploy-pages@v4
3

Commit and push the workflow file

Commit .github/workflows/deploy.yml and push to main. GitHub Actions will trigger immediately, build the project, and publish the dist/ output to your Pages URL.
4

Verify the deployment

Navigate to the Pages URL shown in Settings → Pages to confirm the site is live. Every subsequent push to main will re-run the workflow.

​
Custom Domain

All of the above platforms support custom domains through their respective dashboards — typically a DNS CNAME or A record pointing to the host’s servers. No configuration changes are needed inside the Developer Dossier project itself; because routing is hash-based, the app works correctly regardless of the domain it is served from.
For the fastest first-load performance, enable asset compression (gzip/brotli) and set long cache headers on the assets/ directory — these files have content-hashed filenames so they can be cached indefinitely.

Build docs developers (and LLMs) love

Get started for freeTalk to us