Skip to content

DOC-580 | Improve Docs styling and add ArangoGraph Banner #244

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

Merged
merged 15 commits into from
Sep 29, 2023
Merged

Conversation

nikhil-varma
Copy link
Contributor

@nikhil-varma nikhil-varma commented Sep 27, 2023

Description

  • This PR improves the overall styling of the docs and matches the ArangoGraph's UI styles.
  • Also adds ArangoGraph's banner to the home page of each Doc version specifically 3.10, 3.11 & 3.12

@arangodb-docs-automation
Copy link
Contributor

Deploy Preview Available Via
https://deploy-preview-244--docs-hugo.netlify.app

@Simran-B
Copy link
Contributor

Simran-B commented Sep 27, 2023

The text contrast of inline code is not good, and way too low if it's in a link. The link underline is also not visible below inline code (see "db object" link):

image

It doesn't look good and has too little contrast in headlines as well:
image

The copy button overlapping the content is not nice. There would be space to make the code box wider in this case, but to improve it more generally, could we show the copy button only on hover over the code box?

image

Boxes like here need to be restyled still. Having the same border radius on nested boxes looks wrong:

image

@nikhil-varma nikhil-varma changed the title fix: Style normalization and beautification DOC-580 | Improve Docs styling and add ArangoGraph Banner Sep 28, 2023
@nikhil-varma
Copy link
Contributor Author

nikhil-varma commented Sep 28, 2023

@Simran-B
Links & contrast and the copy button overlap issues are fixed.

Any further changes should be a part of a separate ticket. It becomes tricky to track changes. Let's keep the scope as-is for this one. Please use this ticket to write down whatever is necessary for the next set of issues: https://arangodb.atlassian.net/browse/DOC-585

Copy link
Collaborator

@palashkaria palashkaria left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@nerpaula nerpaula merged commit ead0879 into main Sep 29, 2023
@nerpaula nerpaula deleted the DOC-580 branch September 29, 2023 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants