docs(headless): typedoc website and annotations #4517
Merged
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
jpmarceau
requested review from
olamothe,
fpbrault,
louis-bompart,
alexprudhomme and
fbeaudoincoveo
alexprudhomme
requested changes
Oct 10, 2024
jpmarceau
requested review from
alexprudhomme
and removed request for
louis-bompart
jpmarceau
had a problem deploying
to
PR Artifacts
GitHub Actions
Failure
jpmarceau
had a problem deploying
to
PR Artifacts
GitHub Actions
Failure
jpmarceau
had a problem deploying
to
PR Artifacts
GitHub Actions
Failure
jpmarceau
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
alexprudhomme
approved these changes
Oct 29, 2024
alexprudhomme
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
alexprudhomme
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
fbeaudoincoveo
approved these changes
Oct 30, 2024
packages/headless/src/controllers/core/did-you-mean/headless-core-did-you-mean.ts
Outdated
Show resolved
Hide resolved
alexprudhomme
changed the title
alexprudhomme
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
alexprudhomme
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
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.
KIT-3422
Follows #4361, which prepared the code to build a typedoc website. I couldn't merge it because the incomplete tagging state was causing build problems. I carry over the code changes from that PR in this one here, but they've already been reviewed. We should be able to merge them with this PR here.
Now, the main goal of this PR is adding lots of tags to organize the contents of the Typedoc website. That's why there are lots of file changes; they're very simple and repetitive.
(I also added missing documentation here and there, as I stumbled upon it)
Rather than looking through all files, I recommend looking through the built site and letting me know what you think. Before I keep adding/tweaking things, now would be a good time for feedback 🙂
To look through the built site, either:
1: unzip the following and open
index.html:docs.zip
or
2:
- check out my branch
- run
npm install- run
npm run build:typedocfrom the headless package- open
packages/headless/docs/index.html