bensheldon
commented
7 months ago I'm open if you wanted to mock something up with whatever you're comfortable with 👍
That said, I don't imagine I'd ever adopt VitePress / Vercel as the final form (there's already the /demo Rails site hosted on Heroku, and the option of GitHub Pages for a static site with something Ruby based like Jekyll).
I'll offer that I prefer the one-big-doc because it's easy for me to ctrl-f a keyword. Can you share more about the pain-points you'd want to address, or organizing principles? I can imagine something like more clearly demarcating:
- Summary of features / justification
- Quick Start instructions
- Reference
- Examples and narrative-based explainations
...but I'm curious about what you see. Are there improvements we can make to the current Readme?
Given the increasing size of documentation, I propose migrating it to a separate website. I am willing to create a minimal example to demonstrate the process. If this approach aligns with goals, I can begin migrating the README documentation to the web-based platform.
I intend to utilize VitePress for the documentation website and consider using Vercel for hosting it for preview purposes.
Looking forward to your feedback and further discussion on this proposal.