Skip to content
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

docs: Add documentation on repo folder structure #2635

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

kimadactyl
Copy link
Member

@kimadactyl kimadactyl commented Oct 30, 2024

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation

Fixes #2631

Description

Adds a section describing the current contents of the code base

Motivation and Context

We are currently working to make the codebase more maintainable, so it makes sense to start with an audit of what's there now.

Future updates to the folder structure will need to remember to update this file.

Type of change

  • Documentation update

Huly®: PC-2629

@kimadactyl kimadactyl requested a review from lenikadali October 30, 2024 19:03
@kimadactyl kimadactyl self-assigned this Oct 30, 2024
Copy link
Collaborator

@lenikadali lenikadali left a comment

Choose a reason for hiding this comment

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

Nice work 🙌🏿

Only suggestion I have is to check the Rails guides across versions before deleting anything so that it doesn't bite us later 😅 But that shouldn't stop this from being merged 😇

@kimadactyl
Copy link
Member Author

Nice work 🙌🏿

Only suggestion I have is to check the Rails guides across versions before deleting anything so that it doesn't bite us later 😅 But that shouldn't stop this from being merged 😇

I am hoping the tests stop anything bad happening!

@kimadactyl kimadactyl merged commit a59d094 into main Oct 31, 2024
2 checks passed
@kimadactyl kimadactyl deleted the add-folder-structure branch October 31, 2024 22:39
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.

Add a document describing the layout of the code base
2 participants