The separation of Docs

[Terminay]

Gist

opened this discussion for a quick announcement.

Announcement

consider this as past

As you can tell, the docs consume a major part of the repository which makes it overall heavier to fork, inducing friction for the contributors.

My solution

To resolve that, first of all I saw the docs link leanpass.kilobyte136.workers.dev and thought, "it's lame"; yeah. I know vercel, I'm a big fan, so I explored a bit and then decided for leanpass.vercel.app which is much better.

Then I separated the site content from the library branch making a /docs-site branch specifically for deployment. But kept the docs folder in the main branch (I'll explain why).

So see, I wanted developer friction to be the least for contributions, what if they want to contribute to the docs as well as the library? That's why I left the folder in the main branch and auto transfer it to the docs branch whenever I recieve new changes in the documentation.

Also made a small redirect site with claude (it's surprisingly good) and audited it with copilot (you can see him in the contributors) so that the old url makes the redirects to the actual url by consent (a button. Literally.).

Summary

Made a new branch for this documentation separately but the editing of the documentation (the contributions are still made in the main branch regarding docs) is still in main and auto transferred to the docs branch.

See the current commits for more details and if you have any problems open an issue or fix it yourself by opening a pull request (that's the target yk!).

Peace. Keep coding.