Skip to content
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

Open
HadrienGardeur opened this issue Apr 15, 2024 · 6 comments
Open

Remove early documentation from the repo #36

HadrienGardeur opened this issue Apr 15, 2024 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@HadrienGardeur
Copy link
Member

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.

@HadrienGardeur HadrienGardeur added the documentation Improvements or additions to documentation label Apr 15, 2024
@qnga
Copy link
Member

qnga commented Apr 15, 2024

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
Copy link
Member

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
Copy link
Member Author

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:

  • develop for Readium Mobile
  • dev for Readium Web

@chocolatkey
Copy link
Member

chocolatkey commented Apr 17, 2024

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
Copy link
Member

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
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants