ActiveMDX Software Project Starter

This project is a Next.js site for presenting documentation about a software project.

It uses ActiveMDX to treat individual documents as data.

View the website

Getting Started

1. Clone this repo

$ git clone git@github.com:soederpop/active-mdx-software-project-starter.git ./my-project

2. Install the dependencies

$ npm install
# or if you use yarn
$ yarn

3. Start the dev server

$ yarn dev

Project Documentation

The project documentation lives in docs.

Useful CLI Commands

1. Create a new epic

$ amdx create epic --title "Whatever"

2. Expand the epic into stories

$ amdx action expand epics/whatever

This will create separate story documents for you to further edit.

3. Create a new decision

$ amdx create decision --title "Decision Title"

Github Integration

You can use the github integration to publish the stories from docs/stories to github.

1. Point this package.json to the repository you wish to create issues in, by editing the package.json file's repository field.

{
  "repository": "github:soederpop/active-mdx-software-starter"
}

2. Set your github personal access token in the environment variable GITHUB_PERSONAL_ACCESS_TOKEN

3. Run amdx action github:setup to create the necessary labels for epics and story statuses.

4. Run amdx action github:publish-all to create issues in github, and update your local stories with the github status.