Writing Keystatic docs... in the open 👀

[simonswiss]

Hey friends!

First of all, thank you for trying out Keystatic so early! ❤️

We're aware there is something critically missing from Keystatic right now: documentation.

This is one of the next things we're working on immediately!

Starting today, I'm going to maintain a public Notion space where you can see the docs evolve.

Update: the latest docs now live on https://keystatic.com 💫

---

That comes with the caveat that things might be slightly chaotic at times, but this is the beauty of joining a project within the early peek window!

If you have questions about specific parts you'd like documented, ask away in those GitHub discussions right here. This is helping me figure out what are the early pain points, and I can address those as they come!

Thanks again for being part of this journey with us 🤗

Now let's write some docs! ✍️

[simonswiss]

Here's the first guide I wrote today: Setting up Keystatic with an existing Astro v2 project ✨

[akoepcke]

In section Keystatic Admin UI pages, there's a sentence:

Now, we can import that file in our keystatic/[...rest].astro page, and mount the component on the clientside only:

I believe that should be [...params].astro instead?

[simonswiss]

Yes, thank you! We initially started using ...rest before switching to ...params, and I got mixed up between both 😅

This is fixed now, thanks for pointing that out! 🙏

[teinett]

I started new project Astro + Keystatic, using official docs https://keystatic.com/docs/installation-astro.
I suppose, the project uses markdoc integration https://docs.astro.build/en/guides/integrations-guide/markdoc/, but according to the docs we didn't install it.
Please, add this process to the docs.

[simonswiss]

Hey!

It's in that guide you linked to, but a bit later on, at the "rendering content" part:

https://keystatic.com/docs/installation-astro#astro-s-markdoc-integration

Perhaps we could make a note earlier on that if you want to use Astro's content collections, you also need the Markdoc integration 👍

[simonswiss]

@teinett I've re-visited the Astro integration guide to mention the Markdoc integration earlier on 👍

[jschuur]

Here's the first guide I wrote today: Setting up Keystatic with an existing Astro v2 project ✨

This is super timely for me. Amazing!

[simonswiss]

Haha awesome, glad it's useful!

[simonswiss]

Update: the latest docs now live on https://keystatic.com/ 💫

[radenpioneer]

Would like to help, a little bit!