Decide whether to consolidate semiotic and semiotic-docs repo

nteract / semiotic

A data visualization framework combining React & D3

https://semioticv1.nteract.io/

Other

2.43k stars 132 forks source link

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

Closed willingc closed 2 years ago

willingc commented 2 years ago

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):

[x] 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)

emeeks commented 2 years ago

@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 commented 2 years ago

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

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
The docs website can start using Semiotic code from main branch so we can find regressions and bugs sooner
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 commented 2 years ago

I agree. Let's do it.

willingc commented 2 years ago

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

alexeyraspopov commented 2 years ago

@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

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

willingc commented 2 years ago

@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 commented 2 years ago

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

alexeyraspopov commented 2 years ago

The PR is ready: https://github.com/nteract/semiotic/pull/578