Skip to content
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: bump Docsy to v0.8.0, enable search, enhance highlighting, simplify theme customizations and more fixes #1829

Merged
merged 9 commits into from
Dec 4, 2023

Conversation

mtardy
Copy link
Member

@mtardy mtardy commented Dec 1, 2023

See preview.

This will fix almost all issues in the web development list in the issue #1023.
Closes #1023.

Notably to enable search in the documentation. This breaks compatibility
with the custom changes as they upgraded from bootstrap 4 to boostrap 5.

Signed-off-by: Mahe Tardy <[email protected]>
As Docsy was updated, they moved from Bootstrap 4 to 5 and many of those
custom CSS was not working, this commit removes everything and start
fresh from the default theme. Some customizations will be picked up
again and adjusted in the next commits.

Signed-off-by: Mahe Tardy <[email protected]>
Using shell-session was a bad idea as it is only relevant when placing
command prompt as $ or #. Shell is more appropriate for color syntax.

Signed-off-by: Mahe Tardy <[email protected]>
Algolia provide free research for open-source documentation website.

Signed-off-by: Mahe Tardy <[email protected]>
@mtardy mtardy added area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation. labels Dec 1, 2023
@mtardy mtardy requested a review from a team as a code owner December 1, 2023 20:12
@mtardy mtardy requested a review from jrfastab December 1, 2023 20:12
Copy link

netlify bot commented Dec 1, 2023

Deploy Preview for tetragon ready!

Name Link
🔨 Latest commit 90de443
🔍 Latest deploy log https://app.netlify.com/sites/tetragon/deploys/656dc27ccf8acc0008765278
😎 Deploy Preview https://deploy-preview-1829--tetragon.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mtardy mtardy force-pushed the pr/mtardy/doc-fix-docsy branch 2 times, most recently from 6e897e9 to 442a15b Compare December 1, 2023 20:59
@mtardy mtardy requested a review from willfindlay as a code owner December 1, 2023 20:59
@mtardy mtardy force-pushed the pr/mtardy/doc-fix-docsy branch 3 times, most recently from ca75f7d to 7a0fed9 Compare December 1, 2023 23:41
A big portion is retrieved from the Pixelpoint work, but some of it is
new, the goal is to be lightweight and to not modify the theme too much.
This add many custom fixes to the Docsy theme. It was a bit painful to
do but now I'm a bit familiar with how those things works and hopefully
everything looks more balanced now.

Signed-off-by: Mahe Tardy <[email protected]>
The icon frontmatter is messing up with the CSS for some reasons.

Signed-off-by: Mahe Tardy <[email protected]>
@mtardy mtardy force-pushed the pr/mtardy/doc-fix-docsy branch from 7a0fed9 to 39e899d Compare December 4, 2023 10:40
@mtardy mtardy force-pushed the pr/mtardy/doc-fix-docsy branch from 39e899d to 90de443 Compare December 4, 2023 12:13
@mtardy mtardy merged commit 719ebfb into main Dec 4, 2023
36 checks passed
@mtardy mtardy deleted the pr/mtardy/doc-fix-docsy branch December 4, 2023 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation release-note/docs This PR updates the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation fixes and improvements
2 participants