diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1c174a3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## Added + +### 2026-01-02 + +- Published AT Protocol Lexicons for all core types (`org.stormlightlabs.malfestio.*`) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0b5b4e3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing to Malfestio + +## Ways to Contribute + +### Feature Requests & Bug Reports + +Have an idea or found a bug? We'd love to hear from you! + +- **Open an issue**: [Tangled Issues](https://tangled.org/desertthunder.dev/malfestio/issues) +- **Reach out on Bluesky**: [@desertthunder.dev](https://bsky.app/profile/desertthunder.dev/) +- **Email**: [info@stormlightlabs.org](mailto:info@stormlightlabs.org) + +When reporting bugs, do your best to include: + +- Steps to reproduce the issue +- Expected vs. actual behavior +- Your environment (OS, browser, etc.) + +### Feedback + +General feedback about the project is always welcome. +Feel free to comment on existing issues or reach out via any of the channels above. + +## Development Setup + +See the [README.md](./README.md) for development setup instructions and the [justfile](./justfile) for common development tasks. + +For code contributions, just fork the repository and make your changes. +When you're ready, open a pull request for your branch against `main`. + +## Rules + +Be nice! diff --git a/docs/todo.md b/docs/todo.md index 2e790f1..d033e5b 100644 --- a/docs/todo.md +++ b/docs/todo.md @@ -7,32 +7,8 @@ ## Roadmap Milestones -- **(Done) Milestone A**: Defined core user journeys, information architecture, and privacy rules for the platform. -- **(Done) Milestone B**: Designed AT Protocol Lexicons for all core types and documented data model mapping + publishing pipeline. -- **(Done) Milestone C**: Foundations: Repo, CI, Axum API Skeleton, Solid Shell. - - Monorepo layout, CI, Axum/Solid skeletons implemented. - - Backend running on 8080, Frontend on 3000. -- **(Done) Milestone D**: Identity + Permissions + Publishing Model. - - Auth MVP, Permission model (Private/Public/SharedWith), and basic Publishing flow implemented. - - Backend API and Frontend Editor updated with tests covering permissions and publishing. -- **(Done) Milestone E**: Internal component library/UI Foundation + Animations. -- **(Done) Milestone F**: OAuth + PDS Record Publishing. - - OAuth 2.1 client flow (PKCE, DPoP, handle/DID resolution, token refresh). - - PDS client for `putRecord`, `deleteRecord`, `uploadBlob`. - - TID generation and AT-URI builder in core crate. -- **(Done) Milestone G**: Content Authoring (Notes + Cards + Deck Builder). -- **(Done) Milestone H**: Study Engine (SRS) + Daily Review UX. - - SM-2 spaced repetition scheduler. -- **(Done) Milestone I**: Social Layer v1: Follow graph, Feeds (Follows/Trending), Forking workflow, and Threaded comments. - - Full-text search with pg_trgm/unaccent, visibility filtering, and unified search index. - - Tag taxonomy and Discovery page with top tags. -- **(Done) Milestone J**: Static Content & Landing Page. - - Marketing & Static Site: Landing page, "How it works", About page, Onboarding flow, Empty states, Help center/FAQ section. - - SEO & Meta: Open Graph / Twitter Card meta tags, Sitemap.xml generation, robots.txt configuration. - - Onboarding Flow & Help Center/FAQ - - Empty States -- **(Done) Milestone K**: AppView Indexing. - - Firehose Enhancement (full record storage), Extended Search & Discovery (remote records), and Export/Interop features (JSON export, remote deck view). +> [!NOTE] +> Completed milestones (A-K) have been moved to [CHANGELOG.md](/CHANGELOG.md). ### Milestone L - ATProto Integration Pass