docs: typedoc improvements #1734
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erickzhao
commented
Jun 10, 2024
| "sort": ["kind", "required-first", "alphabetical"], | ||
| "externalSymbolLinkMappings": { | ||
| "@electron/notarize": { | ||
| "NotaryToolCredentials": "https://erickzhao.github.io/notarize/types/NotaryToolCredentials.html" |
There was a problem hiding this comment.
DONOTMERGE: let's merge in electron/notarize#199 first!
malept
reviewed
Jun 10, 2024
Comment on lines
-14
to
-30
| const replaceRef = /^refs\/(head|tag)s\// | ||
|
|
||
| function gitRevisionFromGitHubRef () { | ||
| const githubRef = process.env.GITHUB_REF | ||
| if (githubRef) { | ||
| return githubRef.replace(replaceRef, '') | ||
| } | ||
| } | ||
|
|
||
| const gitRevision = process.argv[2] || gitRevisionFromGitHubRef() | ||
| if (gitRevision) { | ||
| if (/^[0-9a-f]+$/i.test(gitRevision)) { | ||
| config.gitRevision = gitRevision | ||
| } else if (gitRevision.startsWith('v')) { | ||
| config.includeVersion = true | ||
| } | ||
| } |
There was a problem hiding this comment.
thought: I'm pretty sure this is why I used the JS API instead of the CLI.
| "out": "./typedoc", | ||
| "excludeInternal": true, | ||
| "sort": ["kind", "required-first", "alphabetical"], | ||
| "externalSymbolLinkMappings": { |
There was a problem hiding this comment.
thought: oh, they finally added this?? Amazing
|
Do we also need to add explicit external link config for |
felixrieseberg
approved these changes
Jun 17, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1734 +/- ##
==========================================
- Coverage 89.28% 89.06% -0.23%
==========================================
Files 17 17
Lines 905 905
Branches 187 187
==========================================
- Hits 808 806 -2
- Misses 61 62 +1
- Partials 36 37 +1 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Cleanup PR based on learnings from the TypeDoc PRs.
npx typedocrather than JavaScript API removes legacybuild_docs.jsfrom code. Their JavaScript API has minimal documentation, and most options are available viatypedoc.jsonconfiguration anyways.externalSymbolLinkMappingsto show links to types available via external Electron packages (e.g. get and notarize).Tag changes:
@exampletag.[[link tag syntax]]to use{@link tag syntax}.@interfaceto expand utility types whenever possible (e.g. instead ofOmit<TypeA, 'KeyB' | 'KeyC'>, adding the@interfacetag makes it so that all ofTypeA's properties are displayed in the API documentation excludingKeyBandKeyC.@internalandexcludeInternalsto hide types that should not be used by end users of Electron Packager.