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

Consolidate docs to Jekyll site #2561

Merged
merged 6 commits into from
Sep 17, 2024
Merged

Consolidate docs to Jekyll site #2561

merged 6 commits into from
Sep 17, 2024

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Sep 17, 2024

Motivation

We should move all in-used documentation to Jekyll so users won't need to jumping between GH and the documentation site. It'll also make content easier to maintain.

Implementation

  • Moved addons, roadmap, version managers, troubleshooting, semantic highlighting, and editors documentation to Jekyll
  • Updated all the links to these documents

Sidebar structure

Screenshot 2024-09-17 at 17 00 28

Automated Tests

Manual Tests

@st0012 st0012 added the documentation Improvements or additions to documentation label Sep 17, 2024
@st0012 st0012 marked this pull request as ready for review September 17, 2024 14:41
@st0012 st0012 requested a review from a team as a code owner September 17, 2024 14:41
@st0012
Copy link
Member Author

st0012 commented Sep 17, 2024

@vinistock Do we still need SEMANTIC_HIGHLIGHTING.md? I don't see it being linked from anywhere.

We discussed in a call and it is provided for theme developers and devs that want to enhance their themes.

@vinistock
Copy link
Member

Did you move the semantic highlighting docs? I don't see the file on GH.

@st0012 st0012 merged commit 79b9dc1 into main Sep 17, 2024
34 checks passed
@st0012 st0012 deleted the consolidate-docs branch September 17, 2024 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants