-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove early documentation from the repo #36
Comments
On mobile we changed the default branch to |
Mainly because the default branch is the one used by default when creating a PR or cloning the repo. It's confusing for contributors when it's As long as the TS toolkit doesn't have releases and stable versions, I would keep a single branch and work there. |
Yeah, I agree that until we've reached a 1.0 milestone, a single branch would work best. I also noticed an inconsistency in how we name those branches:
|
I'll go ahead and adapt to the readium mobile naming, since there's less people dependent on the TS toolkit |
I noticed the docs are published to https://readium.org/ts-toolkit/ (via GitHub Pages). If we remove the docs completely, that will disappear. Do we want to do something about that? |
That's fine, these docs are not up to date and we'll cover things through https://readium.org/web moving forward. We'll also need a good README and docs for both ts-toolkit and go-toolkit but that's a separate discussion. |
While this was initially meant to be a monorepo hosting the Readium Web project, things shifted to a different approach a while back.
The Readium Web project is now split in two between the TypeScript and Go toolkits but this repo still contains documentation of what it was before in its early days.
We need to remove these documents from the repo and once that's done, I'm also in favor of merging back the
dev
branch intomain
. We're sending the wrong signal when people check this repo and see that the last commit was several years ago.The text was updated successfully, but these errors were encountered: