docs: add antora as main documentation tool#1963
Draft
Conversation
`antora.yml` defines the local documentation project. `antora-playbook.yml` defines all sources that contribute to the documentation site. It is best practice to have this in a separate repostiory as it configures the documentation without actually defining the content. For the start we place it here. Part of the configuration is the UI. We use the antora default UI for now. `ROOT` is the default module in antora. Every module can have `pages`, `partials`, and `examples`. Run `bunx antora antora-playbook.yml` to build the docs.
Under the hood it requires ruby and installing the gems.
`make antora` builds the antora documentation `make antora-attachments` pulls in the api docs as static assets, kotlin an ts for now.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What's new in this PR
PR Submission Checklist for internal contributors
SQPIT-764feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.