search

vtex / shoreline

Design System for the VTEX Admin, previously called Admin UI
https://shoreline.vtex.com
15 stars 0 forks source link

docs: add development guide documentation #1607

Closed lucasaarcoverde closed 1 month ago

lucasaarcoverde commented 2 months ago

Summary

As the title says. Add a step-to-step guide on how to develop on shoreline

vercel[bot] commented 2 months ago

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

1 Ignored Deployment | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **shoreline-docs** | ⬜️ Ignored ([Inspect](https://vercel.com/vtex/shoreline-docs/FtGCCPgGVNWesMsmZvXe6SWojV7R)) | [Visit Preview](https://shoreline-docs-git-docs-how-to-develop-vtex.vercel.app) | | May 14, 2024 8:00pm |
lucasaarcoverde commented 1 month ago

Ainda faz sentido termos as seções Build e Run a command quando as instruções de desenvolvimento estão no DEVELOPMENT_GUIDE?

creio que sim, é um guia curto de como rodar algo no projeto acho interessante pra quem quer mexer no projeto sem necessariamente se aprofundar, caso a pessoa queira contribuir pode ir pro guia de desenvolvimento

marcelovicentegc commented 1 month ago

Ainda faz sentido termos as seções Build e Run a command quando as instruções de desenvolvimento estão no DEVELOPMENT_GUIDE?

creio que sim, é um guia curto de como rodar algo no projeto acho interessante pra quem quer mexer no projeto sem necessariamente se aprofundar, caso a pessoa queira contribuir pode ir pro guia de desenvolvimento

Boa! @lucasaarcoverde só um nitpick: minha impressão quando bati o olho em Run a command foi de que o texto tava incompleto.

lucasaarcoverde commented 1 month ago

Moved to this pr https://github.com/vtex/shoreline/pull/1616