joiful-ts / joiful

TypeScript Declarative Validation for Joi
239 stars 18 forks source link

Issue #65: add generated API docs #223

Closed laurence-myers closed 2 years ago

laurence-myers commented 3 years ago

Generated API Docs are published to https://joiful-ts.github.io/joiful/

docs(readme): add links to API Docs (GitHub Pages)

feat(ci): add job to build and publish the generated API docs

I've set up CI as a separate workflow, but perhaps it should be a job in the existing workflow, so it we only publish docs when the normal tests etc have passed? (Since docs will only be published from master, I don't think it's a big issue, tests should have already been run on the pull request being merged in.)

feat(core): add typedoc, other supporting changes

TODO: update package-lock.json

Closes issue #65

laurence-myers commented 3 years ago

Looks like typedoc doesn't support NodeJS v10. Do we drop support for NodeJS v10, even though it only affects a dev dependency? Or, do we pass --ignore-engines to yarn install?

laurence-myers commented 3 years ago

Looks like typedoc doesn't support NodeJS v10. Do we drop support for NodeJS v10, even though it only affects a dev dependency? Or, do we pass --ignore-engines to yarn install?

I've resolved this by moving "typedoc" to its own sub-project/sub-directory. Now, docs/ contains a separate package.json, containing just typedoc. API docs will be generated into docs/dist/.

laurence-myers commented 2 years ago

Merged without review; better to have some imperfect API docs than none.