Format Images in API Docs
Budget: €12 – €18 EUR
I am tightening up a set of JavaScript-based API docs and need an eye for detail on every diagram and embedded image. The written content is already complete; what is missing is clean, consistent visual formatting that matches the style guide and reads well both online and in print.
Your role is to dive into the existing source files, adjust sizing, alignment, captions, alt-text, and overall visual flow so each diagram supports the explanatory text without breaking layout. You may need to convert or optimise image files (SVG / PNG / JPEG) where quality or load time is an issue, then slot them back into the docs so they render flawlessly in the final build.
Please work directly in the same markup the docs use (Markdown or HTML; I’ll grant repo access on kickoff) and commit changes through Git so I can review diffs easily.
Deliverables:
• Updated documentation files with correctly formatted diagrams and images
• Optimised image assets placed in the appropriate directory structure
• A short change log summarising what was touched and why
I am looking for someone who has already handled visual clean-up on technical documentation, ideally for JavaScript or web APIs, and who is comfortable pushing to a shared repository so we keep a clear history of edits.
Your role is to dive into the existing source files, adjust sizing, alignment, captions, alt-text, and overall visual flow so each diagram supports the explanatory text without breaking layout. You may need to convert or optimise image files (SVG / PNG / JPEG) where quality or load time is an issue, then slot them back into the docs so they render flawlessly in the final build.
Please work directly in the same markup the docs use (Markdown or HTML; I’ll grant repo access on kickoff) and commit changes through Git so I can review diffs easily.
Deliverables:
• Updated documentation files with correctly formatted diagrams and images
• Optimised image assets placed in the appropriate directory structure
• A short change log summarising what was touched and why
I am looking for someone who has already handled visual clean-up on technical documentation, ideally for JavaScript or web APIs, and who is comfortable pushing to a shared repository so we keep a clear history of edits.