Introduction

Welcome to my documentation portfolio

This section of my Docs-as-Code portfolio provides a comprehensive look at technical documentation samples, all authored and published entirely in Markdown using Docusaurus. Here you'll find examples of developer guides, API references, and insights into the workflows used to create them.

Navigation

Guides

• Installing and Applying a Theme to Google Chrome
• Using Postman to Connect to the Stripe API
• Microsoft Word to GitHub Wiki Workflow with Writage
• Route Cloud Application Logs Into a Pipeline
• Tutorial: Fetching Object Data
• Tutorial: Sending a Transaction

API References

• Stripe API Documentation
• Pet Store API Documentation
• Ingest Events via Streaming API
• SuiClient: getObject
• SuiClient: multiGetObjects
• SuiClient: getOwnedObjects

Conceptual/Overview Docs

• Event Streams & Observability Pipelines
• Before You Start
• The SuiClient Architecture

To view the raw markdown files for these docs, head to GitHub.

Workflow

• Drafting with Markdown in VS Code
• Markdown linting with Vale
• Translation with DeepL
• Diagram creation with Mermaid
• Docs versioning with Git
• API validation with Postman and Swagger/OpenAPI
• Publishing with Docusaurus

Tools

• Docusaurus: For generating the static site and documentation.
• VS Code: Primary editor for all content.
• Postman: For API testing and generating API documentation examples.
• Vale: For linting and ensuring style guide adherence.
• Git/GitHub: For version control and hosting.
• Mermaid Chart: Converting Mermaid code into images.
• DeepL: For translation of documentation into multiple languages.

This mirrors how professional teams maintain developer documentation portals such as Docusaurus or similar static-site generators.

Each sample demonstrates end-to-end doc creation: research → drafting → review → publishing.