Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a documentation file that consolidates preferred libraries and tools for the project, moving this information from Notion to the repository for better visibility and version control.
- Introduces
docs/tools.mdwith guidelines for selecting tools and libraries - References existing package registries and documentation sources
- Provides recommendations for server actions and state management
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/tools.md
Outdated
|
|
||
| ## State management library (signals) | ||
|
|
||
| Anong other things, avoid creating a provider at the top just to share the same info in two different areas of the UI. |
There was a problem hiding this comment.
Spelling error: "Anong" should be "Among".
| Anong other things, avoid creating a provider at the top just to share the same info in two different areas of the UI. | |
| Among other things, avoid creating a provider at the top just to share the same info in two different areas of the UI. |
docs/tools.md
Outdated
|
|
||
| ## Other and new packages | ||
|
|
||
| Should none of the above work, or you have a better idea, please verbalise it in `#dev-team`, so we can decide together if that's the right tool, if it's safe to use, or if we have a better alternative. If accepted, add them [in this file](https://github.com/Labrys-Group/common-registry/blob/main/docs/tools.md). |
There was a problem hiding this comment.
Spelling error: "verbalise" should use American English spelling "verbalize" for consistency with typical programming documentation standards.
| Should none of the above work, or you have a better idea, please verbalise it in `#dev-team`, so we can decide together if that's the right tool, if it's safe to use, or if we have a better alternative. If accepted, add them [in this file](https://github.com/Labrys-Group/common-registry/blob/main/docs/tools.md). | |
| Should none of the above work, or you have a better idea, please verbalize it in `#dev-team`, so we can decide together if that's the right tool, if it's safe to use, or if we have a better alternative. If accepted, add them [in this file](https://github.com/Labrys-Group/common-registry/blob/main/docs/tools.md). |
| 1. See [package.json](./../package.json) for tools you might already have at your disposal | ||
| 2. See [create-t3-turbo](https://github.com/Labrys-Group/create-t3-turbo/blob/main/package.json) if there's a lib that does the job | ||
| 3. See [our Shadcn common registry](https://github.com/Labrys-Group/common-registry) if there's a lib that does the job | ||
| 4. See [core library stack](https://www.notion.so/labrys/ee2e6813c3d94cc8ad476c8ecabd09a6?v=7e3f0bfb970941638f9ce6ddffbd36db&source=copy_link) |
There was a problem hiding this comment.
I don't want two sources of truth, but I see this project (common-registry) as being central to our development, so I think having the tools here makes sense, and we can move the whole list in here (cleaned up).
In particular, I strongly think GH is collaborative and in Notion it's hard because there's no PR process and it's not how we devs are used to collaborate (we review PRs every day).
But I can accept the status quo, close this PR, and try again eventually when this repo is used on a daily base.
There was a problem hiding this comment.
It'd be better if this was here in github. I don't have an issue with it.
Wild idea - do we want to add the whole engineering playbook to a repo?
OK, this might be controversial, some of you might prefer the notion page.
I would prefer to have this close to the code and in GH, so changes can be reviewed. It's also easier for devs to find when it's in every repo.
https://www.notion.so/labrys/ee2e6813c3d94cc8ad476c8ecabd09a6?v=7e3f0bfb970941638f9ce6ddffbd36db
/close #31