Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated the main doc site page with product roadmap and some of the language Andy uses for Benefits (links to our sprint and milestones in the GitHub project). 

Had some trouble with the formatting on the Mermaid diagram - hoping for wisdom/assistance!

Also - should this be its own page? Not sure yet how to build out separate markdown files as pages on a doc site.
  • Loading branch information
leelas-pm authored Dec 12, 2024
1 parent 6fb33c9 commit 3c404a4
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,60 @@
Caltrans Performance Measurement System

PeMS is open-source software that is designed, developed, and maintained by [Compiler LLC](https://compiler.la) on behalf of Caltrans Traffic Operations.

## Current Work
We do sprint planning and track day-to-day work in our [Project Board](/https://github.com/orgs/compilerla/projects/3/views/1).

See our current [Milestones](/https://github.com/compilerla/pems/milestones) for a higher level view of project progress.

## Product Roadmap
Our product roadmap captures what we're currently building, what we've built, and what we plan to build in future quarters. It is updated on a regular basis, aligned with project progress.

```mermaid
timeline
title PeMS Product Roadmap
%% PeMS Epics (2024)
section 2024
Q3<br>Complete
: Project launch
: Established resources and overall scope
: Began discovery work
Q4<br>Now
: Confirm site architecture
: Create local environment
: Set up GitHub repository
: Scaffold app structure
: Create a prioritized backlog of features
%% PeMS Epics (2025)
section 2025
Q1<br>Planned
: Support benefits reciprocity between CA transit agencies
: Implement evolved organizing principles for app UX
Q2<br>Planned
: Support for multiple transit processors
: Integration with all MSA transit processors
Q3<br>Future
: Compiler contract ends July 2025
%%{
init: {
'logLevel': 'debug',
'theme': 'default' ,
'themeVariables': {
'cScale0': '#ffa500', 'cScaleLabel0': '#000000',
'cScale1': '#ffff00', 'cScaleLabel1': '#000000',
'cScale2': '#ffff00', 'cScaleLabel2': '#000000',
'cScale3': '#008000', 'cScaleLabel3': '#ffffff',
'cScale4': '#0000ff', 'cScaleLabel4': '#ffffff',
'cScale5': '#4b0082', 'cScaleLabel5': '#ffffff',
'cScale6': '#000000', 'cScaleLabel6': '#ffffff'
}
}
}%%
```

0 comments on commit 3c404a4

Please sign in to comment.