Skip to content

Point README.md to docs.atxp.ai#23

Merged
badjer merged 7 commits intomainfrom
bdj/delete-readmes
Aug 26, 2025
Merged

Point README.md to docs.atxp.ai#23
badjer merged 7 commits intomainfrom
bdj/delete-readmes

Conversation

@badjer
Copy link
Copy Markdown
Contributor

@badjer badjer commented Aug 26, 2025

r? @zachwick

There's still some non-README .md docs in the repo, as well as README.mds in the examples - I haven't touched those. LMK if we should :)

@badjer badjer marked this pull request as ready for review August 26, 2025 19:37
import { createBaseAccountSDK } from "@base-org/account";
import { requestSpendPermission } from "@base-org/account/spend-permission";

export const USDC_CONTRACT_ADDRESS_BASE = "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"; // USDC on Base mainnet
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@zachwick
Copy link
Copy Markdown
Contributor

The individual READMEs for each package were displayed on the npmjs.org page for each package. As long as this results in the top-level README being used for each package, I don't see any issues with this approach. It is just important that we have something for each individual package.

@zachwick
Copy link
Copy Markdown
Contributor

The READMEs in the examples are good to have, and the non-README .md files are fine to leave as well for now. We can always remove/adapt them once more people start using the packages.

@badjer badjer force-pushed the bdj/delete-readmes branch from 5ba50be to 5981e49 Compare August 26, 2025 20:13
Signed-off-by: zach wick <zwick@novellum.ai>
@badjer badjer merged commit dd7e545 into main Aug 26, 2025
1 check passed
@badjer badjer deleted the bdj/delete-readmes branch August 26, 2025 20:25
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