Add: Typedocs #1208
Merged
Add: Typedocs #1208
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
Typedoc configuration
feat: update typedoc generator action
Typedoc configuration
fix: fixed all links in docs
fix: updated action
fix: action
feat: added near-api-js to typedocs
|
|
I know there are a lot of files being changed, but it is only about |
fix: non-overlapping name for action
andy-haynes
approved these changes
Nov 30, 2023
andy-haynes
pushed a commit
that referenced
this pull request
Aug 15, 2024
* feat: add typedoc + change tsconfig.base * feat: add typedoc action * feat: temporary disable release action * feat: update typedoc generator action * feat: update typedoc generator action to support pnpm * feat: update action logic for testing purposes * feat: configure pnpm back to version 7 * feat: update action configuration * feat: change action configuration * feat: update build documentation action * feat: minor changes * feat: update tsconfig.base.json * feat: update typedoc action * feat: add readme option * feat: update entryPoints * feat: update entryPoints * feat: change entryPoints to near-api-js * feat: add package entrypointstrategy * feat: fix adding modules content on typedoc generated documentation * feat: update tsconfig.base.json * feat: update tsconfig * feat: update tsconfig files for each package * feat: add custom-theme * feat: add custom-theme * feat: testing configuration * feat: add externalSymbolLinkMappings * feat: add typedoc-theme * feat: update readme files links * feat: update typedoc options * feat: update tsconfig * feat: update out folder * feat: update typedoc-generator * feat: add target-folder option to typedoc-generator action * feat: update typedoc docs generator to allow linking README files to packages files * feat: minor changes * feat: update typedoc action * feat: elete tsconfig.json * feat: make changes to the step Update gh-pages Branch * feat: update typedoc-generator steps * feat: update action * feat: add user/email * feat: add tsconfig.json.local * feat: add write permissions * feat: github action small change * feat: fix divergent changes on action * feat: small changes * feat: add action that syncs branches * feat: fix permission issues * feat: created generated-documentation folder * feat: add folder * feat: clean code * feat: change action configuration * feat: change out folder to build * feat: enable target-folder * feat: update build destination folder * feat: change action logic * feat: update action * feat: disable pull-request action * feat: clean docs folder * feat: remove lfs: true * feat: update action * feat: add concurrency handler * feat: remove clean option * feat: revert to gh-pages root * feat: enable pull-request.action * feat: add near-api-js package to docs job * feat: disable jekyll * feat: update links on README_TYPEDOC.md * feat: migrate typedoc.json to javascript to handle github full path * feat: delete typedoc.json * feat: fix @link on account.ts * feat: update near-api-js tsconfig * feat: tsconfig test for near-api-js * feat: add lib and text to exclude option * feat: remove @link tag on unresolved link RequestSignTransactionsOptions * feat: add typedoc-plugin-merge-modules * feat: update tsconfig.base * feat: update pnpm-lock * feat: delete tsconfig.json * feat: remove plugin typedoc-plugin-merge-modules * feat: disable old docs-generator action * feat: update near-api-js tsconfig * feat: updtae tsconfig.base * feat: update action * feat: update action * feat: fix failed to resolve link warning * feat: fix not included in the documentation warning * feat: delete typedoc.json file * feat: typedoc update * feat: test @link tag * feat: @link wip * feat: @link change * feat: fix @link near.ts * feat: near.ts @link * feat: change near.ts * feat: update @link * feat: update @link tag * feat: readme.md file update * feat: enable release action * feat: update githubpages option * refactor: update typedoc-generator * fix: fixed all links in docs * fix: updated action * fix: docs * feat: added near-api-js to typedocs * fix: output dir for typedocs * fix: non-overlapping name for action --------- Co-authored-by: few-sw <[email protected]>
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.
Pre-flight checklist
Motivation
Currently there is a weird workflow to create the typedocs, this one is much more streightforward, and will be run on each merge to master.
Test Plan
This PR does not change the package's logic, only the docs.
Here is how they look like: https://gagdiez.github.io/near-api-js/