Skip to content

Docs/architecture documentation#33

Open
YLaxmikanth wants to merge 3 commits into
Labreo:masterfrom
YLaxmikanth:docs/architecture-documentation
Open

Docs/architecture documentation#33
YLaxmikanth wants to merge 3 commits into
Labreo:masterfrom
YLaxmikanth:docs/architecture-documentation

Conversation

@YLaxmikanth

Copy link
Copy Markdown

Summary

Improved repository documentation to make onboarding, development, and maintenance easier for contributors.

Changes Made

  • Added Architecture Overview to README
  • Added Project Structure documentation
  • Added Extension Workflow explanation
  • Added Browser Compatibility notes
  • Added Developer Workflow section to CONTRIBUTING
  • Added Troubleshooting guide
  • Added Important Files reference for contributors
  • Added JSDoc comments to major functions in content.js
  • Added JSDoc comments and module documentation to background.js
  • Added docs/ARCHITECTURE.md documenting runtime components, message flow, browser compatibility, and build process

These changes improve contributor onboarding and help future maintainers understand the extension architecture without modifying runtime behavior.

Fixes #4

Testing

Documentation-only changes.

Verified:

  • Documentation formatting renders correctly
  • Markdown links resolve correctly
  • New architecture document is referenced from README
  • Source code comments do not affect functionality

Checklist

  • I have tested the change locally.
  • I have updated documentation if needed.

@Labreo Labreo left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good try but please reverse all the changes you have made to the incode documents and the readme. I don't want those changes to be there.

Comment thread README.md

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want there to be anything to be added to the main readme. Please remove those changes.

@YLaxmikanth

Copy link
Copy Markdown
Author

Thanks for the feedback. I've reverted the README, in-code documentation, and architecture document changes as requested. I'll revise the contribution to focus only on the documentation areas you'd like improved.

@YLaxmikanth

Copy link
Copy Markdown
Author

Hi @Labreo,

I reviewed the latest documentation updates, including CONTEXT.md, CONTRIBUTING.md, and the current README.

Many of the architecture, workflow, and contributor-onboarding gaps I initially identified now appear to be covered by the recently added documentation.

Could you point me toward any specific areas that still need documentation improvements so I can focus my contribution on the remaining gaps instead of duplicating existing documentation?

Thanks!

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.

Documentation:Add proper documentation throughtout the whole process.

2 participants