home.social

#apidoc — Public Fediverse posts

Live and recent posts from across the Fediverse tagged #apidoc, aggregated by home.social.

  1. Are you writing or maintaining an api doc generator for a programming language?

    Lots of docs are served straight out of git. Please on't generate commit noise on every generated page.

    - Don't generate a version number or time/date onto every page, stick it into the main page at most.
    - Alternatively, use a CSS :before or :after rule to generate such content onto every page. Thereby only the changed CSS shows up in the commit.

    Thanks.

    #typedoc #javadoc #pydoctor #apidoc #doxygen