docs: init docs site

[devdumpling]

Overview

Gave this neat thing by hugo a shot and it worked pretty flawlessly damn

https://bsky.app/profile/hrcd.fr/post/3mdg7lqjbb42g

This scaffolds the basic docs. I gave the files a read and think the content is worth iterating on, but this at least gives us a starting point with all the bells and whistles.

@danielroe / @patak-dev we'll need to setup a subdomain for this and deploy and all that jazz. Will leave that up to y'all.

Views

Ref

Closes #175

[vercel]

@devdumpling is attempting to deploy a commit to the danielroe Team on Vercel.

A member of the Team first needs to authorize it.

[HugoRCD]

@devdumpling Thanks 🙏 I'm somewhat familiar with Docus, so if you need help at any point to clean up the UI and make it look nice, just let me know!

[devdumpling]

@devdumpling Thanks 🙏 I'm somewhat familiar with Docus, so if you need help at any point to clean up the UI and make it look nice, just let me know!

Totally! I actually will need to drop to do some other work for the rest of the day shortly. I just thought I'd get a starting point up for folks to contribute docs to to unblock. Please drop in whatever you're interested in!

Only thing we need to sort out before merging this is if we'd prefer a subdomain / separate app like this or bolt it onto the existing main app.

[Kai-ros]

Looks great so far, the first thing that jumps out to me is a lack of a WHY or MOTIVATION page, akin to how pnpm does it.

Big believer it's worth taking the time to lay out the driving force behind why Daniel created this project and what about it has the community so energized to participate with it. It doesn't have to drag npm but it should certainly speak to the frictions this smooths and the pain points it soothes.

Also, in line with pnpm, I think it's worth it to have the Feature Comparison up front so people can see what they get out of using it without having to go looking for it.

[devdumpling]

Looks great so far, the first thing that jumps out to me is a lack of a WHY or MOTIVATION page, akin to how pnpm does it.

Big believer it's worth taking the time to lay out the driving force behind why Daniel created this project and what about it has the community so energized to participate with it. It doesn't have to drag `npm` but it should certainly speak to the frictions this smooths and the pain points it soothes.

Also, in line with pnpm, I think it's worth it to have the Feature Comparison up front so people can see what they get out of using it without having to go looking for it.

Totally! To be clear, this PR is just a small PR intended to stand up a foundation. It's not comprehensive at all and is mostly just what was generated in the basic create-docs command hugo suggested.

Figured it'd be better to get the basics in so others can add docs / iterate here rather than have the whole of docs blocked on scaffolding.

[devdumpling]

@HugoRCD is there any reason to keep around the skills files after generating? Do they continue to be useful or no?

[HugoRCD]

@HugoRCD is there any reason to keep around the skills files after generating? Do they continue to be useful or no?

Personally, I use skills globally and not in the repo. In theory, you can reuse this skill to give yourself recommendations later on the documentation and how to improve it (as well as the UI and customise the lp). But I think I'll add more skills later, such as /review-docs (for example). To put it simply, I would say no

[patak-cat]

I tried to run it locally, and it renders like this

I'll let others review this one. I don't know what is going on 🤔

[devdumpling]

@HugoRCD is there any reason to keep around the skills files after generating? Do they continue to be useful or no?

Personally, I use skills globally and not in the repo. In theory, you can reuse this skill to give yourself recommendations later on the documentation and how to improve it (as well as the UI and customise the lp). But I think I'll add more skills later, such as /review-docs (for example). To put it simply, I would say no

Cool makes sense. I'm going to pull them from this PR as they're cluttering it up and not really related to the original task.

[devdumpling]

I tried to run it locally, and it renders like this

I'll let others review this one. I don't know what is going on 🤔

I think this is happening due to yaml in here getting auto edited by a formatter, which is adding a bunch of empty lines and breaking the parsing. First guess is it's the auto-action. Let me push a change and see if it gets mangled again.

EDIT: yeah that's what's happening 🤔 cee77a0

Weird that this time it mangled it differently and it won't parse it at all now locally for me.

[danielroe]

thanks for removing the various skills! 🙏

I think the auto-format is coming from oxfmt probably - maybe incompatible with mdc?
we could add the docs dir .md files to an ignore list

[devdumpling]

thanks for removing the various skills! 🙏

I think the auto-format is coming from oxfmt probably - maybe incompatible with mdc? we could add the docs dir .md files to an ignore list

Seems like that's the case ya. Seeing some docs get reformatted into incompatible states while others are okay. We can probably make minor tweaks to make it work, but will ignore for now.

[devdumpling]

Alright I think that should resolve the autoformatting issues. Give it another whirl.

[patak-cat]

awesome! works great locally now

I think we can merge and continue to iterate if this looks good also to deploy