-
Notifications
You must be signed in to change notification settings - Fork 184
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
Docs site styling improvements #4324
Conversation
@camunda/tech-writers I have created this POC PR for the docs site styling - just some quick changes that should hopefully greatly improve the site and UX. We can discuss this in our next team meeting, but feel free to look through the preview site and make any suggestions etc. Note: Don't get hung up on the CSS implementation - this was just a quick and dirty fix to get feedback on the styling - if we are happy with the changes, I'll implement the CSS properly. |
Most of this feedback is personal opinions and just not having the bandwidth to fight Docusaurus and existing styles back when it was just me and @christinaausley 🥲. Thank you for caring and moving this forward! 🙌
To your point, if it improves the accessibility and provides a more modern look and feel, let's do it. That said, I support you on these changes. 👍 |
Great feedback thank you - I agree on the blue, that is actually the blue from the product itself (trying to make it more seamless from product > docs, i.e. link patterns are the same) but I agree the blue is a bit bright with so many page links, so for now I'll revert back to the orange which is more subtle, and we can investigate the link colours in another iteration 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great! 🥳
Removing from 8.6 release, but can release during the week of the release 👍 |
@pepopowitz Please re-review, I have fixed all those issues/edge cases I think - especially badge behaviour/padding etc on pages such as the release notes, and also styles within the API ref docs 🤞 Note: there is no urgency here 👍 |
@pepopowitz I can still see differences in styling between locally run & the preview environment, so I'm going to do some more work on the APi ref styles 🙄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops, I forgot to add my previous few comments as part of this review....but there are still a few wonky bits.
…unda/camunda-docs into mes-364-styling-improvements
Thanks @pepopowitz, great feedback as always - I am sure that these last snags are now fixed. NB: Just FYI the only one that is slightly annoying is the API ref endpoint padding one which I have to refresh on the preview site to see the 'correct' new version - try it in an incognito browser or refresh the page and it works correctly first time, so think this might just be a caching issue. Anyway, these are how the fixes appear in the preview site. Underlines in API specs are correct(including removal of H2 line for GET endpoints that do not have any request body content) Badges vertically aligned to middleHopefully one last review please! p.s. On another note, I have tested in Firefox and all looks good, although in Firefox I noticed an existing issue with the API ref statuses which uses the tabs classes (not fixed with these changes). We could look at this at a future date, just putting it here for now: |
Also to note, some of the guides (e.g. https://docs.camunda.io/docs/guides/orchestrate-human-tasks/) have hard-coded |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Preview environment for this PR has been torn down. |
Thanks @pepopowitz I'll create a follow-up PR to pick this up and any other issues that might crop up once it's merged into production 👍 |
Fixed in #4456 |
Description
This PR contains styling improvements to fix the following user problem.
As a user of the docs site, I am experiencing friction due to the following issues:
The fixes include:
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).