Skip to content

Update Documentation - up to 4/13/26#190

Open
haram082 wants to merge 2 commits intomainfrom
refactors/docs-update
Open

Update Documentation - up to 4/13/26#190
haram082 wants to merge 2 commits intomainfrom
refactors/docs-update

Conversation

@haram082
Copy link
Copy Markdown
Contributor

Context

The project documentation was significantly outdated, with multiple core modules (Voting Platform, Open Forum, Resource reviews) and several API routes undocumented.

Describe your changes

  • OVERVIEW.md: Added missing Core Features (Voting Platform, Open Forum, Academic/Housing Resources) and updated the technology stack to include deployment
    details and file storage.
  • REPOSITORY_STRUCTURE.md: Fully mapped the current file system, including all 11+ backend routes, model files, and the Next.js app/ directory structure.
  • ARCHITECTURE.md: Updated backend architecture descriptions and added a new section on the privacy-preserving atomic voting flow.
  • AUTHENTICATION.md: Corrected model names (from User to SAMLUser), updated field mapping for SAML attributes, and fixed endpoint paths.
  • FEATURES.md: Added detailed feature descriptions for the Voting Platform (RCV, eligibility, write-ins) and Open Forum (event reviews, statistical
    aggregation).
  • GUIDELINES.md: Updated testing requirements to include npm test instructions and corrected curl examples for the current API paths.
  • NonTech_Spec.md: Aligned the voting platform's storage specification with the actual implementation of anonymous individual Vote documents

Testing

Validated everything that was rewritten or added was right.

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
pomonastudents Ready Ready Preview, Comment Apr 17, 2026 0:35am

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant