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

Expose crypto-api as its own typedoc module #4439

Merged
merged 1 commit into from
Oct 7, 2024
Merged

Conversation

richvdh
Copy link
Member

@richvdh richvdh commented Oct 1, 2024

Currently the crypto-api hierarchy is exposed only as a Crypto namespace under the "matrix" entrypoint in the documentation.

This isn't really right: it's meant to be a separate entrypoint (in the same way as types, testing and utils are). This PR fixes that problem.

Before:

image

After:

image

@richvdh richvdh requested a review from a team as a code owner October 1, 2024 16:02
@richvdh richvdh added the T-Task Tasks for the team like planning label Oct 1, 2024
Currently the crypto-api hierarchy is exposed only as a `Crypto` namespace
under the "matrix" entrypoint in the documentation.

This isn't really right: it's meant to be a separate entrypoint (in the same
way as `types`, `testing` and `utils` are). This PR fixes that problem.
@richvdh richvdh added this pull request to the merge queue Oct 7, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 7, 2024
@richvdh richvdh added this pull request to the merge queue Oct 7, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 7, 2024
@richvdh richvdh added this pull request to the merge queue Oct 7, 2024
Merged via the queue into develop with commit 73ab7c3 Oct 7, 2024
26 checks passed
@richvdh richvdh deleted the rav/crypto-api-docs branch October 7, 2024 11:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-Task Tasks for the team like planning
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants