docs: addition of a first pass of documentation on the site (WIP)

[yohannlog]

Hi !

I like this project and intend to contribute as much as I can.

Initially, I plan to add a lot of documentation and examples to the site. For the moment it's in WIP.

Warning: there may be errors in the documentation and some texts may not be displayed correctly, e.g. ( | ) for tables

[changeset-bot]

⚠️ No Changeset found

Latest commit: de72011

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[flo-bit]

Hi, great that you want to contribute 😊

A few notes while you're working on that:

• I like the table of contents component so far, we can move that into one of the packages to be used by everyone eventually, but I'm fine with keeping it in the docs for now too
• there's a lot stuff like this for every component docs page:

<div class="flex gap-8">
	<div class="flex-1 min-w-0">
		<Prose>
			<AvatarDocs />
		</Prose>
	</div>
	<div class="hidden xl:block w-64 flex-shrink-0">
		<TableOfContents />
	</div>
</div>

feel free to move that into it's own component like too, should help with consistency too (I probably should've done that earlier already, but well)

• I'm a fan of one very simple and easy example at the beginning instead of giving people all the options, maybe we could have a further examples section further down instead and just show one simple example at the top
• there's already an <Api /> component for props and stuff, though it's only used for <Accordion /> so far, using that instead of the tables would be great
• the accessibility section is imo already given and doesn't have to be repeated for every component (could maybe be added to the Philosophy page instead)
• I like small PRs (at least when I'm the one who has to review 😅) so feel free to only do a part of the components (e.g. everything in base for now, less is fine too) and I'll merge that in and the others can be part of a separate PR

Great work so far, welcome to the "team" 😊