learn and share notes on atproto (wip) 🦉 malfestio.stormlightlabs.org/
readability solid axum atproto srs

docs: add changelog and contributing guidelines, and migrate completed milestones from todo.md

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