Conduit is a cross-platform note aggregation system designed to solve the problem of scattered notes across different formats and platforms. It provides a centralized repository for all notes with powerful organization, search, and integration capabilities.
This project uses a Memory Bank approach to maintain documentation and project knowledge. The Memory Bank consists of the following core files:
projectbrief.md- Foundation document defining core requirements and goalsproductContext.md- Why this project exists and how it should worksystemPatterns.md- System architecture and design patternstechContext.md- Technologies used and development setupactiveContext.md- Current work focus and next stepsprogress.md- What works, what's left to build, and current status
This project uses GitHub Issues to track tasks from sprint plans. A GitHub Actions workflow has been set up to automatically create issues from the sprint plans defined in memory-bank/progress.md.
The workflow can be triggered in three ways:
- Automatically: When changes are pushed to
memory-bank/progress.mdon the main branch - Manually: Through the GitHub Actions UI
- Locally: Using the
acttool
To manually trigger the workflow:
- Go to the "Actions" tab in your GitHub repository
- Select the "Create Sprint Issues" workflow
- Click "Run workflow"
- Configure the following options:
- Sprint number: Select which sprint to process (1-5), or leave empty to process all sprints
- Create/update GitHub Project: Whether to create or update a GitHub Project
- GitHub Project name: The name of the GitHub Project to use
The workflow requires the following permissions:
issues: write- To create and update issuesproject: write- To create and update projects (if using the project feature)
You may need to update the repository settings to grant these permissions to GitHub Actions.
The workflow:
- Reads the
memory-bank/progress.mdfile - Extracts tasks from the specified sprint section(s)
- Creates GitHub issues for each task that doesn't already exist
- Optionally adds the issues to a GitHub Project
- Labels issues with
sprint-Xandautomatedlabels
You can customize the workflow by editing the .github/workflows/create-sprint-issues.yml file:
- Change the trigger conditions
- Modify the issue format
- Adjust the project integration
- Add additional labels or metadata
See memory-bank/techContext.md for detailed information on the development setup and technical stack.
See memory-bank/progress.md for the current project status and upcoming work.