Skip to content

Move to typedoc #1205

New issue
New issue
Closed
Closed
Move to typedoc#1205
Labels
docs
@wojpawlik

Description

@wojpawlik
wojpawlik
opened on Dec 1, 2020
  • Set up a GitHub action to publish docs on GitHub Pages every release.
  • Try to build docs anyway at every commit to spot breakage early.
  • Remove (now redundant) handwritten API reference.
  • Try to make docs/README.md shorter. Move information into JSDoc. Remove junk. Deduplicate.
  • Avoid putting example code directly into readme, since it's not typechecked there and can easily get outdated.
    Prefer putting it in docs/examples/ and linking to it.
    Or perhaps embed it with <iframe>, Github escapes it, but marked used by typedoc doesn't 😈
  • Make sure docs/README.md contains everything from readme.md.
  • Remove readme.md, now inferior to docs/README.md.
  • Move docs/README.md back to root and update

    telegraf/tsconfig.json

    Line 19 in 1f7dee7

    "readme": "docs/README.md",

Metadata

Metadata

Assignees

No one assigned

    Labels

    docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions