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

Removes @celo/identity docs #112

Merged
merged 1 commit into from
Feb 2, 2024

Conversation

arthurgousset
Copy link
Contributor

@arthurgousset arthurgousset commented Feb 1, 2024

Description

The @celo/identity docs are not automatically generated in celo-org/developer-tooling anymore, and now live in celo-org/social-connect.

For that reason, they are out-of-date, stale, and not relevant in this repository.

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

Related issues

Cleans up docs that are automatically generated since:

Backwards compatibility

Yes, no code change.

Documentation

N/A, deleting documentation

Out-of-scope for this PR

  • automatically generate docs using typedoc in celo-org/social-connect?

  • yarn, then yarn run build, then yarn run docs works as expected, but produces many warnings in the logs:

[@celo/celocli]: (node:52809) SyntaxError Plugin: @celo/celocli: Cannot use import statement outside a module                                       
[@celo/celocli]: module: @oclif/[email protected]                                                                                                         
[@celo/celocli]: task: cacheCommand                                                                                                                 
[@celo/celocli]: plugin: @celo/celocli                                                                                                              
[@celo/celocli]: root: /Users/arthur/Documents/celo-org/developer-tooling/packages/cli                                                              
[@celo/celocli]: See more details with DEBUG=*                                                                                                      
[@celo/celocli]: Process exited (exit code 0), completed in 2s 180ms 
[@celo/base]: [warning] CurrencyObject, defined in ./src/currencies.ts, is referenced by currencies.CURRENCIES but not included in the documentation
.                                                                                                                                                   
[@celo/base]: [warning] InFunction, defined in ./src/async.ts, is referenced by async.retryAsync.retryAsync.inFunction but not included in the docum
entation.                                                                                                                                           
[@celo/base]: [warning] RepeatTaskOptions, defined in ./src/task.ts, is referenced by task.conditionWatcher.conditionWatcher.opts but not included i
n the documentation.                                                                                                                                
[@celo/connect]: [warning] StateMutabilityType, defined in ./src/abi-types.ts, is referenced by abi-types.ABIDefinition.stateMutability but not incl
uded in the documentation.                                                                                                                          
[@celo/connect]: [warning] AbiType, defined in ./src/abi-types.ts, is referenced by abi-types.ABIDefinition.type but not included in the documentati
on.                                                                                                                                                 
[@celo/connect]: [warning] Failed to resolve link to "WalletBase" in comment for connection.Connection.  

This are not automatically generated in celo-org/developer-tooling anymore, and now live in celo-org/social-connect.

For that reason, they are out-of-date, stale, and not relevant in this repository
Copy link

changeset-bot bot commented Feb 1, 2024

⚠️ No Changeset found

Latest commit: 2c128cd

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

@arthurgousset arthurgousset marked this pull request as ready for review February 1, 2024 19:54
@arthurgousset arthurgousset requested a review from a team as a code owner February 1, 2024 19:54
@arthurgousset arthurgousset self-assigned this Feb 1, 2024
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.

The warnings are unrelated to your PR, if anything you removed some 😄

@nicolasbrugneaux nicolasbrugneaux merged commit 76db26d into master Feb 2, 2024
17 checks passed
@nicolasbrugneaux nicolasbrugneaux deleted the arthurgousset/remove-celo/identity-docs branch February 2, 2024 09:49
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