{"id":50998960,"url":"https://github.com/hebertcisco/remodel-core-docs","last_synced_at":"2026-06-20T12:34:11.172Z","repository":{"id":354040991,"uuid":"1221888919","full_name":"hebertcisco/remodel-core-docs","owner":"hebertcisco","description":"Documentation site for remodel-core, built with React Router and Fumadocs.","archived":false,"fork":false,"pushed_at":"2026-04-26T22:17:35.000Z","size":709,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-26T22:21:42.509Z","etag":null,"topics":["data-structures","database","ddl","er-diagram","modeling","parser-implementations","sql"],"latest_commit_sha":null,"homepage":"https://hebertcisco.github.io/remodel-core-docs/","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hebertcisco.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-26T20:07:11.000Z","updated_at":"2026-04-26T22:18:20.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/hebertcisco/remodel-core-docs","commit_stats":null,"previous_names":["hebertcisco/remodel-core-docs"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/hebertcisco/remodel-core-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hebertcisco%2Fremodel-core-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hebertcisco%2Fremodel-core-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hebertcisco%2Fremodel-core-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hebertcisco%2Fremodel-core-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hebertcisco","download_url":"https://codeload.github.com/hebertcisco/remodel-core-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hebertcisco%2Fremodel-core-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34570537,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-20T02:00:06.407Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-structures","database","ddl","er-diagram","modeling","parser-implementations","sql"],"created_at":"2026-06-20T12:34:10.529Z","updated_at":"2026-06-20T12:34:11.161Z","avatar_url":"https://github.com/hebertcisco.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# remodel-core-docs\n\nDocumentation site for [`remodel-core`](https://github.com/hebertcisco/remodel-core), built with React Router and Fumadocs.\n\nThe site documents the Rust modeling engine behind Remodel: conceptual modeling, logical conversion, validation rules, SQL generation, and related integration topics. It also exposes machine-readable documentation endpoints for LLM-oriented consumers.\n\n## Related Links\n\n- GitHub: \u003chttps://github.com/hebertcisco/remodel-core\u003e\n- crates.io: \u003chttps://crates.io/crates/remodel-core\u003e\n- docs.rs: \u003chttps://docs.rs/remodel-core\u003e\n\n## Stack\n\n- React 19\n- React Router 7\n- Fumadocs\n- MDX content in `content/docs`\n- Tailwind CSS 4\n\n## Local Development\n\nInstall dependencies:\n\n```bash\nbun install\n```\n\nStart the dev server:\n\n```bash\nbun run dev\n```\n\nBuild for production:\n\n```bash\nbun run build\n```\n\nServe the production build locally:\n\n```bash\nbun run start\n```\n\nRun static checks:\n\n```bash\nbun run lint\nbun run types:check\n```\n\nIf you prefer, the scripts also work through `npm`, `pnpm`, or `yarn`.\n\n## Available Scripts\n\n- `dev`: starts the React Router development server\n- `build`: creates the production build\n- `start`: serves the built app from `build/server/index.js`\n- `lint`: runs `oxlint`\n- `types:check`: generates route/docs types and runs TypeScript checks\n- `postinstall`: regenerates Fumadocs MDX metadata\n\n## Project Structure\n\n```text\nremodel-core-docs/\n├── app/\n│   ├── components/     # shared MDX/UI helpers\n│   ├── lib/            # source loading, layout, OG helpers\n│   ├── llms/           # LLM-friendly text/MDX endpoints\n│   ├── routes/         # app routes\n│   └── root.tsx\n├── content/docs/       # documentation pages and sidebar metadata\n├── public/             # static assets\n├── source.config.ts    # Fumadocs content source configuration\n└── vite.config.ts\n```\n\n## Writing Docs\n\nDocumentation pages live in `content/docs/*.mdx`.\n\n- Add new pages as MDX files with frontmatter such as `title` and `description`.\n- Keep `content/docs/meta.json` in sync so the sidebar order and section grouping stay correct.\n- The docs route reads content from the generated Fumadocs source, so changing MDX files is usually enough for new content.\n\nThe current docs are organized around:\n\n- introduction and getting started\n- conceptual modeling\n- logical modeling\n- validation and conversion\n- SQL generation\n- integration topics\n\n## Routes\n\nMain routes:\n\n- `/`: landing page\n- `/docs/*`: documentation pages\n- `/api/search`: search endpoint\n- `/og/docs/*`: Open Graph image generation\n\nLLM-oriented routes:\n\n- `/llms.txt`: index of available machine-readable docs\n- `/llms-full.txt`: aggregated plain-text documentation\n- `/llms.mdx/docs/*`: page-level MDX output\n\n## Notes\n\n- The docs source is configured in `source.config.ts` with processed markdown enabled.\n- `types:check` runs both React Router type generation and `fumadocs-mdx`, so it is the safest verification command after content or route changes.\n- Some entries referenced by `content/docs/meta.json` should stay aligned with actual MDX files to avoid broken navigation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhebertcisco%2Fremodel-core-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhebertcisco%2Fremodel-core-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhebertcisco%2Fremodel-core-docs/lists"}