Skip to content

feat: add comprehensive Developer Guide and enhance API documentation - #765

Merged
arunavabasucom merged 1 commit into
arunavabasucom:mainfrom
mohyware:docs/api-and-dev-guide
Aug 13, 2025
Merged

arunavabasucom merged 1 commit into
arunavabasucom:mainfrom
mohyware:docs/api-and-dev-guide

Conversation

@mohyware

@mohyware mohyware commented Aug 6, 2025

Copy link
Copy Markdown
Collaborator
  • Introduced a new DEVELOPER_GUIDE.md file detailing project setup, contributing guidelines, and development processes.
  • Created openapi.json for API documentation, detailing endpoints and features.
  • Refactored payload models with clearer structure and field descriptions for better understanding, and improved route documentation for spectrum calculation and fitting endpoints with detailed explanations and examples.

@vercel

vercel Bot commented Aug 6, 2025

Copy link
Copy Markdown

@mohyware is attempting to deploy a commit to the Main Team on Vercel.

A member of the Team first needs to authorize it.

@codecov

codecov Bot commented Aug 6, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@150576a). Learn more about missing BASE report.
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #765   +/-   ##
=======================================
  Coverage        ?   70.26%           
=======================================
  Files           ?       20           
  Lines           ?      538           
  Branches        ?       44           
=======================================
  Hits            ?      378           
  Misses          ?      148           
  Partials        ?       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@arunavabasucom
arunavabasucom merged commit 6349158 into arunavabasucom:main Aug 13, 2025
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.

2 participants