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

Delete duplicate @celo/phone-utils docs #115

Merged
merged 1 commit into from
Feb 2, 2024

Conversation

arthurgousset
Copy link
Contributor

@arthurgousset arthurgousset commented Feb 1, 2024

Description

Deletes old and duplicate @celo/phone-utils docs at packages/docs/developer-resources/. The deleted docs were (out-of-date) duplicates. The (up-to-date) docs remain available at: packages/docs/sdk/docs/phone-utils

These docs seem to be leftover from a time when docs were autogenerated at packages/docs/developer-resources/<package-name>. See this PR:

Similar out-of-date docs for wallet-hsm-gcp were deleted in this recent commit: Remove granda mento + metatransaction wallet (#10822)

Note

You can assert that docs were generated at packages/docs/developer-resources/<package-name> by inspecting the .gitattributes file at the time.

Tested

No code changes, docs only change.

For completeness, testing relevant node scripts continue to work as expected, in particular docs generation:

  • yarn, then yarn run build, then yarn run docs works

Backwards compatibility

Yes, no code change. Only docs change.

Documentation

Yes, no code change. Only deleting docs.

Copy link

changeset-bot bot commented Feb 1, 2024

⚠️ No Changeset found

Latest commit: eb7c62a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

These seem to have been leftover from a time when docs were autogenerated differently, presumably at `packages/docs/developer-resources/<package-name>`. See this PR: celo-org/celo-monorepo#6199

You can see that docs were generated at `packages/docs/developer-resources/<package-name>` by inspecting the `.gitattributes` file at the time: https://github.com/celo-org/celo-monorepo/pull/6199/files#diff-618cd5b83d62060ba3d027e314a21ceaf75d36067ff820db126642944145393e
@arthurgousset arthurgousset force-pushed the arthurgousset/delete-duplicate-docs branch from 00c98ad to eb7c62a Compare February 1, 2024 21:11
@arthurgousset arthurgousset self-assigned this Feb 1, 2024
@arthurgousset arthurgousset marked this pull request as ready for review February 1, 2024 21:28
@arthurgousset arthurgousset requested a review from a team as a code owner February 1, 2024 21:28
Copy link
Contributor

@nicolasbrugneaux nicolasbrugneaux left a comment

Choose a reason for hiding this comment

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

Nice cleaning up!

@nicolasbrugneaux nicolasbrugneaux merged commit 0805fe4 into master Feb 2, 2024
17 checks passed
@nicolasbrugneaux nicolasbrugneaux deleted the arthurgousset/delete-duplicate-docs branch February 2, 2024 09:54
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.

2 participants