Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 10, 2025

Description

Enhanced documentation clarity and usability:

  • Localhost URLs: Converted plain text URLs to clickable markdown links in docs/boson-environments.md for local environment configuration table (subgraph, dApps, and widgets)
  • React hook examples: Updated useCoreSdk code examples in docs/guides/use-with-react.md to include proper import statement and required configId parameter
  • Code formatting: Applied consistent line breaks in packages/common/src/configs.ts for IPFS gateway URLs
// Before
const readOnlyCoreSdk = useCoreSdk({
  envName: "testing"
});

// After
import { hooks } from "@bosonprotocol/react-kit";

const readOnlyCoreSdk = hooks.useCoreSdk({
  envName: "testing",
  configId: "testing-80002-0"
});

How to test

  • Verify markdown links render correctly in docs/boson-environments.md
  • Confirm useCoreSdk examples in docs/guides/use-with-react.md are copy-paste ready with valid imports and parameters

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copilot AI changed the title [WIP] Define configuration inputs in JSON files chore: improve documentation for localhost links and useCoreSdk examples Nov 10, 2025
Copilot AI requested a review from levalleux-ludo November 10, 2025 14:50
@levalleux-ludo levalleux-ludo marked this pull request as ready for review November 10, 2025 16:21
@levalleux-ludo levalleux-ludo merged commit fb1ec66 into docs-and-configuration Nov 10, 2025
4 of 7 checks passed
@levalleux-ludo levalleux-ludo deleted the copilot/sub-pr-986 branch November 10, 2025 16:22
levalleux-ludo added a commit that referenced this pull request Nov 10, 2025
#986)

* chore: define configuration inputs in JSON files and update the doc about environments

* rework the localhost links in doc file

* fix lint

* wip

* Initial plan (#989)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
@codecov
Copy link

codecov bot commented Nov 10, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.98%. Comparing base (982fefd) to head (9dd364c).

Additional details and impacted files
@@                   Coverage Diff                   @@
##           docs-and-configuration     #989   +/-   ##
=======================================================
  Coverage                   90.98%   90.98%           
=======================================================
  Files                         176      176           
  Lines                        7190     7190           
  Branches                     1322     1322           
=======================================================
  Hits                         6542     6542           
  Misses                        648      648           
Flag Coverage Δ
common 92.59% <0.00%> (ø)
core-sdk 56.41% <0.00%> (ø)
e2e 86.08% <0.00%> (ø)
eth-connect-sdk 95.06% <0.00%> (ø)
ethers-sdk 74.45% <0.00%> (ø)
ipfs-storage 91.75% <0.00%> (ø)
metadata 94.70% <0.00%> (ø)
unittests 60.76% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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