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

Decide whether to consolidate semiotic and semiotic-docs repo #572

Closed
1 of 4 tasks
willingc opened this issue Dec 20, 2021 · 8 comments · Fixed by #578
Closed
1 of 4 tasks

Decide whether to consolidate semiotic and semiotic-docs repo #572

willingc opened this issue Dec 20, 2021 · 8 comments · Fixed by #578
Labels
documentation 📚 Examples and updates to the docs enhancement

Comments

@willingc
Copy link
Member

willingc commented Dec 20, 2021

As we move to 2.0 and beyond, let's take a look at modernizing our documentation toolchain and content.

Possible ideas and random thoughts (please share more in the chat):

  • create a monorepo (pros / cons)
  • strive for beautiful colors and typography such as in the existing docs
  • interactivity in examples
  • doc review of existing components

FYI @emeeks @alexeyraspopov David Gwer (asked status on Slack)

@willingc willingc added documentation 📚 Examples and updates to the docs enhancement labels Dec 20, 2021
@emeeks
Copy link
Member

emeeks commented Dec 20, 2021

@alexeyraspopov & I have been discussing it and we feel like combining the main repo and the docs repo is the way to go. So, unless anyone has a compelling counterargument, that's how we're going to do it.

@alexeyraspopov
Copy link
Member

There are several benefits from having docs as a part of main repo I see:

  1. A single source of truth for both devs and users. This is where can have all Semiotic-related discussions, make atomic updates in both code and docs, align the package and docs release cycle
  2. The docs website can start using Semiotic code from main branch so we can find regressions and bugs sooner
  3. Single repo means simply fewer things to manage

I was planning to open a PR to pull the docs in this repo, possibly preserving git history.

@willingc
Copy link
Member Author

I agree. Let's do it.

@willingc
Copy link
Member Author

Decision made to create a monorepo. @alexeyraspopov will get us started on combining the repos.

@alexeyraspopov
Copy link
Member

@emeeks I tried to figure out which branch of semiotic-docs to pull in, and I'm not sure: semiotic-2 has changes that are not in main and possibly does not have some changes from main
image

Do you remember any specific items from main branch that can possibly be cherry-picked to semiotic-2?

@willingc
Copy link
Member Author

willingc commented Dec 21, 2021

@alexeyraspopov I did an interactive rebase of the branches in the semiotic-docs repo. This branch (semi-together) should resolve conflicts with main and have the 4 commits ahead from semiotic-2. Building the styleguidist docs works from head of the semi-together branch.

@alexeyraspopov
Copy link
Member

@willingc, the branch looks good, I'll use it for migration. Thanks!

@alexeyraspopov
Copy link
Member

The PR is ready: #578

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📚 Examples and updates to the docs enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants