Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Enable viewing Tasks source code with typedoc tool #3229

Merged
merged 12 commits into from
Dec 8, 2024

Conversation

claremacrae
Copy link
Collaborator

Types of changes

Changes visible to users:

  • Contributing Guidelines (prefix: contrib - any improvements to documentation content for contributors - see Contributing to Tasks)

Internal changes:

  • Infrastructure (prefix: chore - examples include GitHub Actions, issue templates)

Description

  • Add development dependency on the TypeDoc tool
  • Add new yarn script:
    • yarn code-docs
  • Add new page to the contributing site, showing how to use and maintain this facility:

Motivation and Context

  • Make it much easy to see the class hierarchy
  • Make it easy to search the source code and navigate around it

How has this been tested?

  • Viewing the generated docs in Chrome
  • Viewing the new Contributing page in Obsidian

Screenshots (if appropriate)

The new Contributing page shows what the generated docs look like:

image

Checklist

Terms

It's named like this to support the option of moving to different
documentation tools in future, if anything better comes along.
So that they are also applied when code-docs is run on the command line.
And quotes do not need to be escaped.
This is the default, and I've selected it because users can always
use a modifier key to open in a separate tab.

I'm saving this, to make it easy to temporarily switch it to opening
in a new tab or window in future.
@claremacrae claremacrae added the type: internal Only regards development or contributing label Dec 8, 2024
Copy link

sonarqubecloud bot commented Dec 8, 2024

@claremacrae claremacrae merged commit c8820e6 into main Dec 8, 2024
4 checks passed
@claremacrae claremacrae deleted the code-reference branch December 8, 2024 13:22
@claremacrae
Copy link
Collaborator Author

Hi @ilandikov This might be of interest...

@claremacrae claremacrae changed the title Code reference chore: Enable viewing Tasks source code with typedoc tool Dec 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: internal Only regards development or contributing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant