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

Update the CLI docs to use the developer-tooling repository as a submodule #1211

Merged
merged 4 commits into from
Feb 2, 2024

Conversation

nicolasbrugneaux
Copy link
Contributor

@nicolasbrugneaux nicolasbrugneaux commented Jan 31, 2024

The goal is to make everyone's lives easier by firstly changing the docs to use a submodule, and secondly, create a pull-request keeping it in sync whenever the CLI gets released. You can see an example of a PR that would be created in such events here: #1210

The automation work can be followed in this PR:

Note: initially the goal was to use symlinks to the submodule but instead hardcopies need to be made because of a bug in docusaurus .

Regardless, your workflow shouldn't change as the submodules get fetched after running yarn or yarn install.

@nicolasbrugneaux nicolasbrugneaux requested review from a team as code owners January 31, 2024 17:24
Copy link

netlify bot commented Jan 31, 2024

Deploy Preview for celo-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e35c468
🔍 Latest deploy log https://app.netlify.com/sites/celo-docs/deploys/65bbcdf61d336500072336f7
😎 Deploy Preview https://deploy-preview-1211--celo-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@therealharpaljadeja therealharpaljadeja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very cool! Would be great if someone can advice on how we can achieve this for other packages too...

@therealharpaljadeja therealharpaljadeja merged commit daef610 into celo-org:main Feb 2, 2024
7 checks passed
@arthurgousset
Copy link
Contributor

This is very cool! Would be great if someone can advice on how we can achieve this for other packages too...

+1, I think we (@celo-org/devtooling) will consider doing this for @celo/... NPM packages. What other packages did you have in mind @therealharpaljadeja ?

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

Successfully merging this pull request may close these issues.

3 participants