Skip to content

docs: fix stale inspector docs, product names and perf claims - #1163

Merged
lcottercertinia merged 4 commits into
certinia:mainfrom
lukecotter:bug-docs-accuracy
Oct 8, 2026
Merged

lcottercertinia merged 4 commits into
certinia:mainfrom
lukecotter:bug-docs-accuracy

Conversation

@lukecotter

Copy link
Copy Markdown
Collaborator

📝 PR Overview

The docs site had drifted from the product. The inspector page said the Timeline summary reads the whole log, but it now follows the part on screen. The Timeline legend highlight had no docs. The guide named an action that does not exist. Some pages used the wrong product name. The home page and changelog tied the speed-up to a 100 MB log and to timings from one machine.

This branch fixes each page against the code and the merged PRs. The speed-up claims now say large logs, and give 100 MB only as the log they were measured on.

🛠️ Changes made

🧩 Type of change (check all applicable)

  • 🐛 Bug fix - something not working as expected
  • ✨ New feature – adds new functionality
  • ♻️ Refactor - internal changes with no user impact
  • ⚡ Performance Improvement
  • 📝 Documentation - README or documentation site changes
  • 🔧 Chore - dev tooling, CI, config
  • 💥 Breaking change

📷 Screenshots / gifs / video [optional]

N/A

🔗 Related Issues

related #999
related #1137
related #1149

✅ Tests added?

  • 👍 yes
  • 🙅 no, not needed
  • 🙋 no, I need help

📚 Docs updated?

  • 🔖 README.md
  • 🔖 CHANGELOG.md
  • 📖 help site
  • 🧪 Marked any pre-release-only features (README 🧪 badge — see RELEASING.md)
  • 🙅 not needed

Anything else we need to know? [optional]

  • Test plan: pnpm lint, pnpm exec jest --selectProjects docs (28 tests) and docusaurus build all pass, with no broken links or anchors.
  • One commit per area. Review commit by commit.

…ith the demo button

The claims say large logs. The 100 MB figure is the test log, and larger logs work too. The changelog drops the machine timings. The demo button moves to the left of its label.
Find and the Features index said Apex Debug Log Analyzer. Find showed two titles. The footer said Certinia inc.
…art on screen

The Timeline page had no legend section (certinia#1137). The inspector page said the Timeline summary reads the whole log, but it follows the part on screen (certinia#999, certinia#1149).
…old keys

The guide named a Go to Call Tree action that does not exist. Getting Started did not say that Variables and Flow usage need higher debug levels. The fold table had no Mac keys for Fold all and Unfold all.
@lcottercertinia
lcottercertinia merged commit fd6eb84 into certinia:main Oct 8, 2026
9 checks passed
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