Skip to content

docs(ia): add developer starting point to Get Started overview - #1319

Merged
codyjlandstrom merged 1 commit into
mainfrom
docs/ia/add-developer-getting-started-entry
Aug 4, 2026
Merged

docs(ia): add developer starting point to Get Started overview#1319
codyjlandstrom merged 1 commit into
mainfrom
docs/ia/add-developer-getting-started-entry

Conversation

@ekline

@ekline ekline Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Summary

Image alt-text audit scoped to the docs site and the _posts directory, per the ekline-image-alt-audit skill.

  • ekline-app/ekline-docs/src/content (114 md/mdx files): no issues found. The only images present are the 4 Maintained by EkLine credit badges, which already carry descriptive alt text.
  • ekline-app/src/_posts (95 mdx files): 7 images across 3 posts had empty alt text. All 7 are fixed in this PR.

Total images scanned: approximately 120 - Total fixed: 7 - Deferred: none (well under the 20-image batch limit)

Alt text added

File Image Alt text added
the-great-api-first-lie-what-it-really-means-and-how-to-get-it-right.mdx 6973c8c69c2f8c522ced7ce6_Screenshot-2026-01-24-at-01.00.05.png Code comparison showing a concise good API response with just userId, name, and status, next to a bloated firehose bad API response exposing internal IDs, nested profile data, account details, and login history
the-real-cost-of-a-wrong-api-example-in-financial-services.mdx 69b2c14003a674ceaaae8f69_how-examples-break.png Diagram titled 3 Ways Code Examples Silently Break, showing three worsening scenarios: an endpoint changes but the example does not (deprecated path), a required field is added and the example breaks integrations, and a default value changes silently, moving money the wrong way
the-real-cost-of-a-wrong-api-example-in-financial-services.mdx 69b2c173619fdbab762887b9_write-once-pray-forever.png Six-step diagram titled The Pattern: Write Once, Pray Forever, tracing how fintech docs decay: a feature ships, docs and examples are written accurately, the feature evolves for 6-12 months, the API reference is maybe updated, guide examples are not updated, and a developer copies the stale example, moving money wrong
the-real-cost-of-a-wrong-api-example-in-financial-services.mdx 69b2c21eebcfce7e4e5cfe04_what-best-platforms-do.png List titled What the Best Fintech Platforms Do: Stripe, Twilio, and Plaid, covering generating examples from the API itself, auto-generating and testing at scale, listening to how developers use examples, contract testing, and automating mechanical quality checks on every pull request
the-real-cost-of-a-wrong-api-example-in-financial-services.mdx 69b2c2790160542e6d11b52c_business-case.png Stat grid titled The Business Case, showing $152M average annual API downtime cost per financial institution, a 4:1 docs quality return on investment (ROI), $400B annual Global 2000 downtime cost, 60% of lost customers from failed payments, 76% of failed integrations from bad docs, and $50K per API failure from unannounced changes
the-real-cost-of-a-wrong-api-example-in-financial-services.mdx 69b2c312da3384d0baf79bbd_four-week-plan.png Four-week timeline titled The Minimum Viable Safety Net, covering auditing the quickstart in week 1, fixing quickstart examples in week 2, adding example testing to CI in week 3, and expanding to the top 5 integration guides in week 4
why-sentence-style-capitalization-matters-for-better-documentation.mdx 67ae7b0b2cc4de2890442fdc_visual-selection.png Mind map titled Benefits and Tools for Sentence-Style Capitalization, branching into natural reading flow, consistency, accessibility, industry adoption by Microsoft and Google, and implementation tools including EkLine Docs Reviewer, Grammarly, ProWritingAid, Microsoft Word, and Google Docs

Images that could not be accessed

None. All 7 flagged images were found locally under ekline-app/public/assets/images/blog/ and viewed directly to write context-accurate alt text.

Test plan

  • Spot-check the rendered blog posts to confirm alt text displays correctly and matches each image
  • Confirm no other posts in _posts still have empty alt text (verified via grep at authoring time)

ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>


📝 Created with EkLine · View session

Signed-off-by: ekline[bot] <202747777+ekline[bot]@users.noreply.github.com>
@netlify

netlify Bot commented Aug 1, 2026

Copy link
Copy Markdown

Deploy Preview for okteto-docs ready!

Name Link
🔨 Latest commit b63665c
🔍 Latest deploy log https://app.netlify.com/projects/okteto-docs/deploys/6a6e358f3bf01e0008dd38a3
😎 Deploy Preview https://deploy-preview-1319--okteto-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@codyjlandstrom
codyjlandstrom merged commit 39718de into main Aug 4, 2026
4 checks passed
@codyjlandstrom
codyjlandstrom deleted the docs/ia/add-developer-getting-started-entry branch August 4, 2026 21:09
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.

1 participant