docs: improve installation instructions and customize theme#2
Merged
Conversation
REL-194 Implements the new theme, including docs.json and associated assets for the documentation
Unfortunately, I was unable to push my branch to the Git repository. I have prepared the docs.json file and new assets, including the light/dark logo and an Open Graph image, all contained in a .zip file. I would appreciate it if we could replace the current green assets with these purple ones, as they align more closely with our landing page. {
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"appearance": {
"default": "dark",
"strict": false
},
"name": "Relay",
"colors": {
"primary": "#746ADB",
"light": "#8B82E6",
"dark": "#5E52B0"
},
"favicon": "/favicon.svg",
"navigation": {
"tabs": [
{
"tab": "Documentation",
"groups": [
{
"group": "Getting started",
"pages": [
"documentation/getting-started/introduction",
"documentation/getting-started/quickstart",
"documentation/getting-started/concepts"
]
},
{
"group": "Community & support",
"pages": [
"documentation/community/roadmap",
"documentation/community/contributing",
"documentation/community/faq",
"documentation/community/support"
]
}
]
},
{
"tab": "Changelog",
"groups": [
{
"group": "Changelog",
"pages": [
"changelog/overview"
]
}
]
}
],
"global": {
"anchors": [
{
"anchor": "Documentation",
"href": "https://docs.relaycli.com",
"icon": "book-open-cover"
},
{
"anchor": "Community",
"href": "https://discord.gg/T4zbT7RcVy",
"icon": "discord"
},
{
"anchor": "Manifesto",
"href": "https://relaycli.com/manifesto",
"icon": "feather"
}
]
}
},
"logo": {
"light": "/logo/black.svg",
"dark": "/logo/white.svg",
"href": "https://relaycli.com"
},
"navbar": {
"links": [
{
"label": "Support",
"href": "mailto:hi@relaycli.com"
}
],
"primary": {
"type": "github",
"href": "https://github.com/relaycli/relay"
}
},
"footer": {
"socials": {
"x": "https://x.com/relaycli",
"github": "https://github.com/relaycli",
"linkedin": "https://linkedin.com/company/relaycli"
}
},
"seo": {
"metatags": {
"og:title": "Relay",
"og:description": "Email infrastructure for modern applications"
},
"image": "/meta/og.png"
},
"contextual": {
"options": [
"copy",
"view",
"chatgpt",
"claude"
]
},
"fonts": {
"family": "Geist Mono"
}
} |
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
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.
This PR:
Complete REL-194