search

readium / ts-toolkit

A toolkit for ebooks, audiobooks and comics written in Typescript
BSD 3-Clause "New" or "Revised" License
55 stars 9 forks source link

Remove early documentation from the repo #36

Open HadrienGardeur opened 5 months ago

HadrienGardeur commented 5 months ago

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 into main. We're sending the wrong signal when people check this repo and see that the last commit was several years ago.

qnga commented 5 months ago

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 into main. We're sending the wrong signal when people check this repo and see that the last commit was several years ago.

On mobile we changed the default branch to develop. IMHO, the default branch should be the one contributions are expected to be based on.

mickael-menu commented 5 months ago

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 main.

As long as the TS toolkit doesn't have releases and stable versions, I would keep a single branch and work there.

HadrienGardeur commented 5 months ago

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:

chocolatkey commented 5 months ago

I'll go ahead and adapt to the readium mobile naming, since there's less people dependent on the TS toolkit Edit: Done, dev --> develop and develop is default

chocolatkey commented 5 months ago

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?

HadrienGardeur commented 5 months ago

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.