Skip to content

docs: add search, standard-vs-async guide, API class examples#41

Merged
Mateusz7410 merged 1 commit into
mainfrom
feature/async-0006
Jun 21, 2026
Merged

docs: add search, standard-vs-async guide, API class examples#41
Mateusz7410 merged 1 commit into
mainfrom
feature/async-0006

Conversation

@Mateusz7410

Copy link
Copy Markdown
Collaborator

Summary

  • Enable VitePress local search (themeConfig.search, MiniSearch, no new deps)
  • Add "Standard Apex vs Async Lib" parity page covering Queueable, Batchable, and Schedulable, including Database.Stateful, QueryLocator, and where job logic lives
  • Open each API page (Queueable / Batchable / Schedulable) with a full job-class example
  • Cross-link the new page from getting-started and the home hero
  • Remove invalid footer: false (fixes a TS type error); fix an Async.AsyncResult typo in batchable.md

Why

Issue #31 asked for docs search, more standard-vs-async examples, and a class example at the top of each API page so readers don't have to jump to getting-started.

Test plan

Docs-only change, so the Apex scratch-org lanes (verify.sh full / ns) don't apply.

  • prettier --list-different clean on all touched files
  • npm run docs:build passes (dead-link check included)
  • Local browser check: search renders and returns the new page for "Database.Stateful"; new page + cross-links render; no console errors

Files

  • website/introduction/standard-apex-vs-async-lib.md (new)
  • website/api/queueable.md
  • website/api/batchable.md
  • website/api/schedulable.md
  • website/.vitepress/config.mts
  • website/getting-started.md
  • website/index.md

Closes #31

Address issue #31:
- enable VitePress local search
- add Standard Apex vs Async Lib parity page (queueable, batchable,
  schedulable), covering Database.Stateful, QueryLocator and where job
  logic lives
- open each API page with a full job-class example
- cross-link the new page from getting-started and the home hero

Closes #31
@vercel

vercel Bot commented Jun 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
async-lib Ready Ready Preview, Comment Jun 21, 2026 8:07pm

Request Review

@Mateusz7410
Mateusz7410 merged commit d65189c into main Jun 21, 2026
3 checks passed
@github-actions

Copy link
Copy Markdown

🧪 Apex Test Results

✅ All Tests Passed

==========================================
     APEX TEST EXECUTION SUMMARY
==========================================

📊 Total Tests: 153
✅ Passed: 153
❌ Failed: 0
⏭️  Skipped: 0


🎉 All tests passed successfully!

📦 Download Full Test Results & Logs


📊 Stats: 153 total | ✅ 153 passed | ❌ 0 failed
🤖 Automated comment by Salesforce CI

@codecov

codecov Bot commented Jun 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.06%. Comparing base (af838f7) to head (fe6ab0f).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #41   +/-   ##
=======================================
  Coverage   99.06%   99.06%           
=======================================
  Files          15       15           
  Lines         963      963           
=======================================
  Hits          954      954           
  Misses          9        9           
Flag Coverage Δ
Apex 99.06% <ø> (ø)

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

☔ View full report in Codecov by Harness.
📢 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.

Documentation update

1 participant