Skip to content

README.md

Latest commit

 

History

History
20 lines (15 loc) · 903 Bytes

README.md

File metadata and controls

20 lines (15 loc) · 903 Bytes

Docs Portfolio — Luís Guedes da Silva

A public, non-proprietary portfolio showing how I build documentation as a product: information architecture, developer-focused writing, docs-as-code workflows, and API documentation.

Live site: https://luisjguedes.github.io/docs-portfolio/

Highlights

  • Structured docs (Concept / How-to / Reference / Troubleshooting)
  • Docs-as-code (Markdown + MkDocs Material) with CI checks (GitHub Actions)
  • Quality guardrails: Microsoft-aligned style linting with Vale (runs in CI)
  • Style guide: STYLE_GUIDE.md
  • API documentation sample using OpenAPI (api/openapi.yaml)
  • Diagramming sample using Mermaid

Notes

All content is generic and created for portfolio purposes only (no employer or confidential material).

Contact