Skip to content

task: Docs Housekeeping #888

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.

Sign up for GitHub

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

Jump to bottom
Merged
Custard7 merged 7 commits into from
Dec 16, 2025
Merged

task: Docs Housekeeping #888

Custard7 merged 7 commits into from
Dec 16, 2025

Conversation

@Custard7
Copy link
Collaborator

@Custard7 Custard7 commented Dec 16, 2025

PR: Documentation Audit & Improvements

Summary

This PR performs a comprehensive audit of the docs/ folder to ensure accuracy, fix code errors, and improve developer experience. All changes follow the Diátaxis documentation framework.

Changes

🐛 Bug Fixes

Code Syntax Errors

  • Fixed missing await on learnCard.addPlugin() calls
  • Fixed missing commas and assignment operators in code snippets
  • Fixed incorrect variable references in plugin examples

Incorrect Package References

  • Updated import { initLearnCard } from '@learncard/core' → '@learncard/init' across all docs
  • Fixed getLearnCloudPlugin import to use @learncard/learn-cloud-plugin
  • Fixed didkit WASM import to use @learncard/didkit-plugin

Outdated Context URLs

  • Updated boost context URLs from 1.0.0 → 1.0.3 in 9 files

✨ Improvements

CLI Documentation (docs/sdks/learncard-cli.md)

  • Modernized from deprecated wallet.* API to learnCard.invoke.*
  • Updated variable name from wallet to learnCard
  • Fixed CLI usage to use npx @learncard/cli (not global install)

Landing Pages (docs/README.md, docs/SUMMARY.md)

  • Simplified language, removed jargon ("Consentful" → "Consent-Driven")
  • Fixed broken placeholder links to direct links
  • Added inline install command
  • Collapsed 19 plugin entries in TOC to single "Plugins" link
  • Removed hidden stub page from TOC

Quick Start (docs/quick-start/)

  • Fixed CLI section to use correct npx pattern
  • Standardized Node.js version requirement to v18+

Empty Pages Filled

  • docs/sdks/official-plugins/README.md — Added plugin overview table
  • docs/tutorials/verify-credentials.md — Added complete verification tutorial

📚 Developer Guidance

CLAUDE.md

  • Added new "Documentation" section explaining:
    • GitBook structure and syntax
    • Diátaxis framework (tutorials, how-to, reference, explanation)
    • Editing guidelines for code snippets
    • Key files and patterns

@changeset-bot
Copy link

changeset-bot bot commented Dec 16, 2025

⚠️ No Changeset found

Latest commit: 4923cde

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

@netlify
Copy link

netlify bot commented Dec 16, 2025 •
edited
Loading

✅ Deploy Preview for staging-learncardapp canceled.

Name Link
🔨 Latest commit 4923cde
🔍 Latest deploy log https://app.netlify.com/projects/staging-learncardapp/deploys/6941ea7036d8430008abaa54

@netlify
Copy link

netlify bot commented Dec 16, 2025 •
edited
Loading

✅ Deploy Preview for learncarddocs canceled.

Name Link
🔨 Latest commit 4923cde
🔍 Latest deploy log https://app.netlify.com/projects/learncarddocs/deploys/6941ea70b01a0500084d8097

@Custard7 Custard7 marked this pull request as ready for review December 16, 2025 23:26
@Custard7 Custard7 had a problem deploying to learn-card-app-production December 16, 2025 23:26 — with GitHub Actions Failure
@Custard7 Custard7 had a problem deploying to learn-card-app-production December 16, 2025 23:26 — with GitHub Actions Failure
@Custard7 Custard7 merged commit 401d17a into main Dec 16, 2025
15 of 19 checks passed
@Custard7 Custard7 deleted the update-docs branch December 16, 2025 23:26
@gitstream-cm
Copy link
Contributor

gitstream-cm bot commented Dec 16, 2025

🥷 Code experts: no user but you matched threshold 10

Custard7 has most 👩‍💻 activity in the files.
Custard7 has most 🧠 knowledge in the files.

See details

CLAUDE.md

Activity based on git-commit:

Custard7
DEC 1 additions & 1 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 81%

docs/README.md

Activity based on git-commit:

Custard7
DEC 56 additions & 26 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/SUMMARY.md

Activity based on git-commit:

Custard7
DEC 171 additions & 13 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/core-concepts/credentials-and-data/getting-started-with-boosts.md

Activity based on git-commit:

Custard7
DEC 504 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/how-to-guides/connect-systems/connect-a-game.md

Activity based on git-commit:

Custard7
DEC 481 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/how-to-guides/connect-systems/connect-a-website.md

Activity based on git-commit:

Custard7
DEC 463 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/how-to-guides/deploy-infrastructure/connect-to-independent-network.md

Activity based on git-commit:

Custard7
DEC 598 additions & 1 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/how-to-guides/deploy-infrastructure/the-simplest-plugin.md

Activity based on git-commit:

Custard7
DEC 347 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/how-to-guides/implement-flows/claim-data-after-guardian-consent.md

Activity based on git-commit:

Custard7
DEC 384 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/introduction/ecosystem-architecture.md

Activity based on git-commit:

Custard7
DEC 154 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/quick-start/setup-and-prerequisites.md

Activity based on git-commit:

Custard7
DEC 166 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/quick-start/your-first-integration.md

Activity based on git-commit:

Custard7
DEC 232 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/sdks/learncard-cli.md

Activity based on git-commit:

Custard7
DEC 183 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/sdks/learncard-core/construction.md

Activity based on git-commit:

Custard7
DEC 1315 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/sdks/learncard-core/writing-plugins.md

Activity based on git-commit:

Custard7
DEC 896 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/sdks/learncard-network/authentication.md

Activity based on git-commit:

Custard7
DEC 208 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/sdks/learncloud-storage-api/authentication.md

Activity based on git-commit:

Custard7
DEC 146 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/sdks/official-plugins/README.md

Activity based on git-commit:

Custard7
DEC 2 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/sdks/official-plugins/claimable-boosts.md

Activity based on git-commit:

Custard7
DEC 441 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/tutorials/create-a-boost.md

Activity based on git-commit:

Custard7
DEC 392 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/tutorials/create-a-connected-website.md

Activity based on git-commit:

Custard7
DEC 800 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/tutorials/create-a-credential.md

Activity based on git-commit:

Custard7
DEC 744 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

docs/tutorials/verify-credentials.md

Activity based on git-commit:

Custard7
DEC 6 additions & 0 deletions
NOV
OCT
SEP
AUG
JUL

Knowledge based on git-blame:
Custard7: 100%

✨ Comment /gs review for LinearB AI review. Learn how to automate it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Custard7