Skip to content

docs: Update Contribution Guidelines & architecture documentation with accurate component details #737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

vinay22573
Copy link

What type of PR is this? (check all applicable)

  • 📕 Documentation

Description

This PR updates the architecture documentation to accurately reflect the current codebase structure. The changes include:

  1. Component Details Update

    • Added missing frontend components (Fields, PlotSpectra, Header, InfoPopover, DownloadButtons)
    • Updated backend component structure to match actual directory organization
    • Made component descriptions more specific and accurate
  2. Documentation Improvements

    • Added more detailed component roles and responsibilities
    • Improved clarity of component relationships
    • Ensured documentation matches actual implementation

Checklist

  • I have read the contribution guidelines
  • I have tested these changes locally
  • I have updated the documentation
  • The changes follow the project's coding standards

Impact

These changes improve the accuracy and completeness of the architecture documentation, making it easier for:

  • New contributors to understand the codebase structure
  • Developers to locate specific components
  • Maintainers to track component relationships

Copy link

vercel bot commented Apr 5, 2025

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

A member of the Team first needs to authorize it.

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