docs(headless): typedoc plugin for coveo search box and theming #4361
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
fpbrault,
y-lakhdar,
alexprudhomme,
fbeaudoincoveo,
spiracha-coveo and
npushkarskii
and removed request for
a team
jpmarceau
changed the title
jpmarceau
changed the title
jpmarceau
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
|
I'll merge this for now because the new sprint starts today, but if you have you have comments I can handle them in my next PR 👍 |
jpmarceau
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 30, 2024
[KIT-3422](https://coveord.atlassian.net/browse/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](https://github.com/user-attachments/files/17497151/docs.zip) or 2: - check out my branch - run `npm install` - run `npm run build:typedoc` from the headless package - open `packages/headless/docs/index.html` [KIT-3422]: https://coveord.atlassian.net/browse/KIT-3422?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ --------- Co-authored-by: Alex Prudhomme <[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.
https://coveord.atlassian.net/browse/KIT-3421
This is the first of a number of PRs to generate Headless documentation using https://typedoc.org/
Here, I create a typedoc plugin to add an Atomic search box to the generated website, and theme it.
I suggest merging to a typedoc-release-branch rather than to master because the tags are in a messy state at the moment. I have enough to work on the plugin, but that's it. My next task will be to go through them to clean up and generate the typedoc website will all the content we want. Avoiding master will also help to avoid conflicts with the v3 release. Typedoc can wait until v3.
You can preview by:
npm installnpm run build:typedocfrom the headless packagepackages/headless/docs/index.html