feat: ds-docs plataforma de documentação do design system #453
Open
cesaroeduardo wants to merge 54 commits intomainfrom
Open
feat: ds-docs plataforma de documentação do design system #453cesaroeduardo wants to merge 54 commits intomainfrom
cesaroeduardo wants to merge 54 commits intomainfrom
Conversation
This reverts commit c0460a2.
…into ds-docs-platform
fix nos nomes e alguns valores de semantic tokens para não conflitarem com outros padrões do tailwind e estarem mais próximos da abordagem de mercado e escala de design system
…to ds-docs-platform
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adicionando a plataforma de documentação do Azion Design System ao monorepo. O ds-docs é o hub de documentação dos componentes e regras do design system (@aziontech/webkit), permitindo visualizar componentes, fundações (tokens, cores, tipografia), exemplos de uso e um playground interativo.
O que foi entregue
Documentação de componentes
Páginas por componente (props, eventos, slots), com conteúdo em
src/content/v1/enesrc/content/v1/pt, gerado e validado em cima do código empackages/webkit/src.Extração automática a partir do webkit
Scripts que leem
packages/webkit/srce geram/atualizam a documentação: extração de API (props, eventos, slots a partir dos .vue) e scaffold de páginas (cria/atualiza os .mdx de componentes). Assim, alterações no webkit podem ser refletidas na doc rodandobuild:apiebuild:scaffold(oubuild:scaffold --forcepara sobrescrever arquivos existentes).Fundações e tokens
Páginas de design foundations (tokens semânticos, cores, tipografia) e integração com o tema (@aziontech/theme).
Playground
Ambiente interativo para testar componentes do webkit com controles de props, troca de tema (claro/escuro) e mock do status da Azion para o
AzionSystemStatus. Permite teste em tempo real; atualizando no webkit reflete no playground.Busca
Busca em toda a documentação via índice estático (
search-index.json) gerado no build.i18n
Conteúdo em inglês e português, organizado por versão e idioma (v1/en, v1/pt).
CI e qualidade
packages/webkit/src.Stack e integração
@aziontech/webkit,@aziontech/icons,@aziontech/theme.Estrutura relevante
apps/ds-docs/— app Astro da documentação.src/content/v1/{en,pt}/(components, foundations, get-started, etc.).apps/ds-docs/scripts/(extractComponentApi, scaffoldComponentDocs, checkComponentDocs, build-search-index, etc.)..github/workflows/docs.yml(disparo em mudanças emapps/ds-docs/**,packages/**e no próprio workflow).Como testar
Rodar a documentação localmente
# Na raiz do monorepo pnpm install pnpm --filter ds-docs run devAcesse
http://localhost:4321(ou a URL exibida no terminal).Build de produção
cd apps/ds-docs pnpm build pnpm previewExtrair componentes do webkit e gerar/atualizar docs
Checagens do CI (opcional)
Débitos