appsmith icon indicating copy to clipboard operation
appsmith copied to clipboard

Added documentation on Appsmith's Software Architecture

Open Rooney30 opened this issue 2 years ago • 4 comments

Created a file called Architecture.md that will explain the architecture of Appsmith. Added formatting as well as illustrations.

Pull Request Template

Use this template to quickly create a well written pull request. Delete all quotes before creating the pull request.

Description

Please include a summary of the changes and which issue has been fixed. Please also include relevant motivation and context. List any dependencies that are required for this change Links to Notion, Figma or any other documents that might be relevant to the PR These changes included an md file about Appsmith's Software Architecture.

Add a TL;DR when description is extra long (helps content team)

Fixes #3600

Add a page about Appsmith's architecture

Media

A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video

Type of change

  • This change requires a documentation update

How Has This Been Tested?

  • Manual

Test Plan

Add Testsmith test cases links that relate to this PR

Issues raised during DP testing

Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR)

Checklist:

Dev activity

  • [ ] My code follows the style guidelines of this project
  • [ ] I have performed a self-review of my own code
  • [ ] I have commented my code, particularly in hard-to-understand areas
  • [ ] I have made corresponding changes to the documentation
  • [ ] My changes generate no new warnings
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • [ ] New and existing unit tests pass locally with my changes
  • [ ] PR is being merged under a feature flag

QA activity:

  • [ ] Test plan has been approved by relevant developers
  • [ ] Test plan has been peer reviewed by QA
  • [ ] Cypress test cases have been added and approved by either SDET or manual QA
  • [ ] Organized project review call with relevant stakeholders after Round 1/2 of QA
  • [ ] Added Test Plan Approved label after reveiwing all Cypress test

Rooney30 avatar Nov 29 '22 21:11 Rooney30

Welcome to the Appsmith community! Thank you for your first pull request and making this project better. 🤗 Please make sure that you raise a review request so your code change does not go unnoticed.

welcome[bot] avatar Nov 29 '22 21:11 welcome[bot]

@Rooney30 is attempting to deploy a commit to the Appsmith Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Nov 29 '22 21:11 vercel[bot]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
appsmith ✅ Ready (Inspect) Visit Preview Nov 29, 2022 at 9:45PM (UTC)

vercel[bot] avatar Nov 29 '22 21:11 vercel[bot]

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

github-actions[bot] avatar Dec 07 '22 16:12 github-actions[bot]

@Rooney30 Thanks for creating such a detailed writeup about Appsmith's architecture. My only concern with architecture documents is that they have a tendency to go out of date very quickly. Do you have any tips on how we can/should keep this docs updated with any changes happening to the code base?

mohanarpit avatar Dec 12 '22 16:12 mohanarpit

@mohanarpit Any update here?

@theparthacus some variant of this could even be a page on our website, once Arpit approves this PR, right?

Rishabhkaul avatar Dec 23 '22 01:12 Rishabhkaul

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

github-actions[bot] avatar Jan 07 '23 16:01 github-actions[bot]