Skip to content

RENAH-HTTP/MkDocs_Documentation_Mockup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Live Documentation (Mockup)

Live site: https://renah-http.github.io/Ableton_Documentation_Mockup/

If you don't see the latest content, refresh the page (Ctrl+Shift+R / Cmd+Shift+R).


A documentation mockup for Ableton Live, built with MkDocs and the Material theme. Created for interview purposes to demonstrate structure, tone, and how I would approach writing documentation for software workflows, audio effects, and release notes.

Contents

  • Manual — Audio effects reference and workflow documentation
  • Release Notes — Live 12 release notes

Local Development

Prerequisites: Python 3.x

  1. Create and activate a virtual environment:

    python -m venv venv
    # Windows
    venv\Scripts\activate
    # macOS/Linux
    source venv/bin/activate
  2. Install dependencies:

    pip install mkdocs mkdocs-material
  3. Serve locally:

    mkdocs serve

    The site will be available at http://127.0.0.1:9001.

Deployment

Pushes to main automatically build and deploy to GitHub Pages via the workflow in .github/workflows/ci.yml.

Releases

No releases published

Packages

 
 
 

Contributors