Part 6: I put the documentation on a real website!
What's the difference between documentation that exists and documentation people can actually find? For weeks, everything for Troyal, my fictional royalty-tracking API, lived in a GitHub repo. Today it's a live website,
What's the difference between documentation that exists and documentation people can actually find?
For weeks, everything for Troyal, my fictional royalty-tracking API, lived in a GitHub repo. Today it's a live website, and I'm excited to share it!
All it took was one small file. I added a _config.yml with a theme, a title and a short description, then switched on GitHub Pages. Two minutes later, my README had become a home page, and every guide I'd written (the API design, Getting Started, error codes, changelog and webhooks) had its own page with working links. Seeing it load as a real site was a great moment.
The part that taught me the most was a link that wouldn't click. My Portfolio link showed up as plain text, and I stared at it for far too long. The cause was a single line break between the link text and the address. Markdown wants them side by side, and one stray line break turns a link into plain text. Documentation is full of details like that, and readers only notice when something doesn't work.
See it live: https://joycefoster642.github.io/Troyal-API-Docs/
Next: ownership splits and royalty statements, because you asked for them! πΆ
I'm also open to Technical Writing positions, so if your team is hiring, I'd love to hear from you.
Troyal is fictional. The documentation is real.
Everything is public on GitHub: https://github.com/joycefoster642/Troyal-API-Docs
Originally published by Dev.to WebDev. Aggregated on AIWithGhost for educational purposes β full credit and traffic to the original publisher.