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

chore: update README and package.json #2026

Merged
merged 2 commits into from
Oct 19, 2023

Conversation

huijing
Copy link
Contributor

@huijing huijing commented Oct 12, 2023

Sadly, Playwright just updated itself, so the ridiculous build issue on Netlify is bacccckkkkkk. Given that Playwright did the release on 12 Oct 2023, we should take note of the time it takes for Netlify deploy to clear its cache.
Update: the pipeline turned green on 19 Oct 2023

The same has happened to our docs-styleguide as well on the Github pipeline, refer to interledger/docs-styleguide#7. We should take note of how long Github takes to clear its cache as well.

Changes proposed in this pull request

  • This PR removes our documentation's React dependency
  • It also updates our README to provide most current information

Context

Closes #2025

Checklist

  • Related issues linked using fixes #number
  • Tests added/updated
  • Documentation added
  • Make sure that all checks pass
  • Postman collection updated

@netlify
Copy link

netlify bot commented Oct 12, 2023

Deploy Preview for brilliant-pasca-3e80ec ready!

Name Link
🔨 Latest commit 8c91341
🔍 Latest deploy log https://app.netlify.com/sites/brilliant-pasca-3e80ec/deploys/6530dd207f67a20008b54479
😎 Deploy Preview https://deploy-preview-2026--brilliant-pasca-3e80ec.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.

@github-actions github-actions bot added pkg: documentation Changes in the documentation package. type: documentation (archived) Improvements or additions to documentation labels Oct 12, 2023
Copy link
Contributor

@mkurapov mkurapov left a comment

Choose a reason for hiding this comment

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

LGTM, just one suggestion

@@ -8,21 +8,21 @@ This website is built with [Starlight](https://starlight.astro.build/), a docume

### Local Development

- Make sure all the dependencies for the website are installed:
- Make sure all the dependencies for the website are installed. Because this is a monorepo, you should run the following command in the root of the project folder:
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe something like "should run the following in this project folder (/packages/documentation)" to differentiate from the "root"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just assumed the person would install the dependencies throughout the repo. Because when we make changes to the dependencies on the repo, the pnpm-lock is updated outside the repo anyway.

"@types/react": "^18.2.28",
"@types/react-dom": "^18.2.13",
"astro": "3.2.3",
"@interledger/docs-design-system": "^0.1.0",
Copy link
Contributor

Choose a reason for hiding this comment

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

🎉

@huijing huijing force-pushed the chj/2025/update-dependencies-and-readme branch from 080d71c to 1e7477b Compare October 19, 2023 07:12
@huijing huijing merged commit badee4d into main Oct 19, 2023
21 checks passed
@huijing huijing deleted the chj/2025/update-dependencies-and-readme branch October 19, 2023 07:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: documentation Changes in the documentation package. type: documentation (archived) Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation to remove React dependency
3 participants