Skip to content

chore: replace starter boilerplate with project documentation#19

Open
y4motion wants to merge 1 commit into
intuition-box:mainfrom
y4motion:chore/remove-starter-boilerplate
Open

chore: replace starter boilerplate with project documentation#19
y4motion wants to merge 1 commit into
intuition-box:mainfrom
y4motion:chore/remove-starter-boilerplate

Conversation

@y4motion
Copy link
Copy Markdown

@y4motion y4motion commented May 9, 2026

What

Replaces the generic Fumadocs/Create Fumadocs starter README with proper project documentation.

Changes

  • README.md — New README covering:
    • Stack overview (Next.js, Fumadocs, @waveso/ui, Tailwind CSS)
    • Getting started guide
    • Project structure reference
    • Key features summary
    • Links to governance, grants, missions, and community
  • source.config.ts — Replaced generic starter comment with concise reference

Why

The current README is still the default Fumadocs scaffold ("This is a Next.js application generated with Create Fumadocs"). A proper README helps new contributors onboard faster and reflects the maturity of the project.

Closes #2

- Replace generic Fumadocs starter README with proper documentation
  covering stack, project structure, features, and quickstart guide
- Clean up boilerplate comment in source.config.ts

Closes intuition-box#2
@host-intuition-box
Copy link
Copy Markdown

host-intuition-box Bot commented May 9, 2026

The preview deployment for Intuition.box is ready. 🟢

Open Preview | Open Build Logs | Open Application Logs

Last updated at: 2026-05-09 23:17:19 CET

@y4motion
Copy link
Copy Markdown
Author

y4motion commented May 9, 2026

Note on preview deployment: If the Coolify preview fails, it's likely due to missing @waveso/ui peer dependencies (@base-ui/react, class-variance-authority, clsx, tailwind-merge). This also affects the main branch — not introduced by this PR.

We ran into the same issue on Ontology PR #11 and fixed it there by adding the missing peer deps to package.json. Happy to open a separate fix PR here if that would help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove all docusaurus starter doc

1 participant