Skip to content

Commit aec3542

Browse files
committed
docs: Adicionar guia de publicação no npm
- Documentar fluxo completo: changeset → version → publish - Incluir instruções de consumo dos pacotes - Adicionar estratégia de versionamento e troubleshooting
1 parent 2257c25 commit aec3542

72 files changed

Lines changed: 429 additions & 334 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

ai-friendly/.github/instructions/ybyra-domain.instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ When editing files in `domain/` directories, follow these rules:
3333

3434
## Reference
3535

36-
See `ai-friendly/rules/` and `ai-friendly/skills/create-domain/` for full details.
36+
See the [Core Concepts](https://devitools.github.io/ybyra/guide/schema-definition) and [Domain Layer](https://devitools.github.io/ybyra/react/domain) guides for full details.

ai-friendly/.github/instructions/ybyra-react-web.instructions.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,31 @@ When editing React Web pages for Ybyra:
88

99
## Page Pattern
1010

11-
```
12-
import { Scope } from "@ybyra/core";
13-
import { allPermissions, {Domain}Schema } from "@ybyra/demo";
14-
import { DataForm, DataPage, useComponent } from "@ybyra/react-web";
15-
import { useNavigate } from "react-router-dom";
11+
```tsx-no-check
12+
import { useNavigate } from 'react-router-dom';
13+
import { DataForm, DataPage, useComponent } from '@ybyra/react-web';
14+
import { permissions } from '@src/auth';
15+
import { ExampleSchema } from '@src/domain/example';
1616
17-
export function {Domain}Page() {
17+
export function ExamplePage () {
1818
const navigate = useNavigate();
1919
const component = useComponent(scope, scopes, navigate);
20-
const schema = {Domain}Schema.provide();
20+
const schema = ExampleSchema.provide();
2121
2222
return (
23-
<DataPage domain={schema.domain} scope={scope} permissions={allPermissions(schema)}>
24-
<DataForm schema={schema} scope={scope} ... />
23+
<DataPage
24+
domain={schema.domain}
25+
scope={scope}
26+
permissions={permissions}
27+
>
28+
<DataForm
29+
schema={schema}
30+
scope={scope}
31+
permissions={permissions}
32+
...
33+
/>
2534
</DataPage>
26-
);
35+
)
2736
}
2837
```
2938

@@ -37,4 +46,4 @@ export function {Domain}Page() {
3746

3847
## Reference
3948

40-
See `ai-friendly/frameworks/react-web.md` for complete guide.
49+
See the [React Web guide](https://devitools.github.io/ybyra/react/overview) for complete documentation.

ai-friendly/.github/instructions/ybyra-svelte.instructions.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,20 @@ When editing SvelteKit pages for Ybyra:
88

99
## Page Pattern
1010

11-
```
11+
```svelte-no-check
1212
<script lang="ts">
1313
import { goto } from "$app/navigation";
1414
import { base } from "$app/paths";
1515
import { Scope } from "@ybyra/core";
16-
import { allPermissions, {Domain}Schema } from "@ybyra/demo";
16+
import { permissions } from "@src/auth";
17+
import { ExampleSchema } from "@/domain/example";
1718
import { createComponent, DataForm, DataPage } from "@ybyra/sveltekit";
1819
19-
const schema = {Domain}Schema.provide();
20+
const schema = ExampleSchema.provide();
2021
const component = createComponent(scope, scopes, goto, base);
2122
</script>
2223
23-
<DataPage domain={schema.domain} scope={scope} permissions={allPermissions(schema)}>
24+
<DataPage domain={schema.domain} scope={scope} permissions={permissions}>
2425
<DataForm schema={schema} scope={scope} ... />
2526
</DataPage>
2627
```
@@ -35,4 +36,4 @@ When editing SvelteKit pages for Ybyra:
3536

3637
## Reference
3738

38-
See `ai-friendly/frameworks/sveltekit.md` for complete guide.
39+
See the [SvelteKit guide](https://devitools.github.io/ybyra/svelte/overview) for complete documentation.

ai-friendly/.github/instructions/ybyra-vue.instructions.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ When editing Vue pages for Ybyra:
88

99
## Page Pattern
1010

11-
```
11+
```vue-no-check
1212
<template>
1313
<DataPage :domain="domain" :scope="scope" :permissions="permissions">
1414
<DataForm :schema="schema" :scope="scope" ... />
@@ -17,10 +17,11 @@ When editing Vue pages for Ybyra:
1717
1818
<script setup lang="ts">
1919
import { Scope } from "@ybyra/core";
20-
import { allPermissions, {Domain}Schema } from "@ybyra/demo";
20+
import { permissions } from "@src/auth";
21+
import { ExampleSchema } from "@/domain/example";
2122
import { DataForm, DataPage, useComponent } from "@ybyra/vue-quasar";
2223
23-
const schema = {Domain}Schema.provide();
24+
const schema = ExampleSchema.provide();
2425
const component = useComponent(scope, scopes);
2526
</script>
2627
```
@@ -34,4 +35,4 @@ const component = useComponent(scope, scopes);
3435

3536
## Reference
3637

37-
See `ai-friendly/frameworks/vue-quasar.md` for complete guide.
38+
See the [Vue + Quasar guide](https://devitools.github.io/ybyra/vue/overview) for complete documentation.

ai-friendly/examples/person/domain.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Schema Definition (`domain/person/schema.ts`)
44

5-
```typescript
5+
```ts-no-check
66
import { action, date, group, text, Text, toggle, Position, Scope } from "@ybyra/core";
7-
import { schema } from "../../settings/schema";
7+
import { schema } from "@/settings/schema";
88
99
export const PersonSchema = schema.create("person", {
1010
groups: {
@@ -29,8 +29,8 @@ export const PersonSchema = schema.create("person", {
2929

3030
## Events (`domain/person/events.ts`)
3131

32-
```typescript
33-
import { PersonSchema } from "./schema";
32+
```ts-no-check
33+
import { PersonSchema } from "@/domain/person/schema";
3434
3535
export const personEvents = PersonSchema.events({
3636
active: {
@@ -55,10 +55,10 @@ export const personEvents = PersonSchema.events({
5555

5656
## Handlers (`domain/person/handlers.ts`)
5757

58-
```typescript
58+
```ts-no-check
5959
import type { ServiceContract } from "@ybyra/core";
60-
import { PersonSchema } from "./schema";
61-
import { createDefault } from "../../settings/handlers";
60+
import { PersonSchema } from "@/domain/person/schema";
61+
import { createDefault } from "@/settings/handlers";
6262
6363
export function createPersonHandlers(service: ServiceContract) {
6464
return PersonSchema.handlers({
@@ -72,10 +72,10 @@ export function createPersonHandlers(service: ServiceContract) {
7272

7373
## Hooks (`domain/person/hooks.ts`)
7474

75-
```typescript
75+
```ts-no-check
7676
import type { ServiceContract } from "@ybyra/core";
77-
import { PersonSchema } from "./schema";
78-
import { createDefault } from "../../settings/hooks";
77+
import { PersonSchema } from "@/domain/person/schema";
78+
import { createDefault } from "@/settings/hooks";
7979
8080
export function createPersonHooks(service: ServiceContract) {
8181
return PersonSchema.hooks(createDefault(service));
@@ -84,8 +84,8 @@ export function createPersonHooks(service: ServiceContract) {
8484

8585
## Barrel Export (`domain/person/index.ts`)
8686

87-
```typescript
88-
export { PersonSchema } from "./schema";
87+
```ts-no-check
88+
export { PersonSchema } from "@/domain/person/schema";
8989
export { personEvents } from "./events";
9090
export { createPersonHandlers } from "./handlers";
9191
export { createPersonHooks } from "./hooks";

ai-friendly/examples/person/i18n.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Locale File
44

5-
```typescript
5+
```ts-no-check
66
// settings/locales/pt-BR.ts
77
export const ptBR = {
88
person: {
@@ -43,7 +43,7 @@ export const ptBR = {
4343

4444
## Merge with core translations
4545

46-
```typescript
46+
```ts-no-check
4747
import { ptBR } from "@ybyra/core"; // common translations
4848
import { ptBR as local } from "./locales/pt-BR"; // domain translations
4949

ai-friendly/examples/person/pages/react-native.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Person Domain — React Native Screens
22

33
## Setup (demo.ts)
4-
```typescript
4+
5+
```ts-no-check
56
import { createLocalDriver } from "@ybyra/persistence";
6-
import { createPersonService, createPersonHandlers, createPersonHooks } from "@ybyra/demo";
7+
import { createPersonService, createPersonHandlers, createPersonHooks } from "@/domain/person";
78
89
const driver = createLocalDriver();
910
export const personService = createPersonService(driver);

0 commit comments

Comments
 (0)