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.

Sign up for GitHub

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

Jump to bottom

🚀 Docs Site Improvements #4319

Merged
merged 107 commits into from
Jan 20, 2023
Merged

🚀 Docs Site Improvements #4319

merged 107 commits into from
Jan 20, 2023

Conversation

AyhamAl-Ali
Copy link
Member

@AyhamAl-Ali AyhamAl-Ali commented Sep 4, 2021 •
edited
Loading

Description

This PR aims to improve the docs site after last restyle #3935

Live Preview: https://ayhamal-ali.github.io/Skript/ (up-to-date)

Changelog (Will be updated continuously) (up-to-date)

  • 🟢 Added DarkMode (Switcher, AutoLoad from cookies)
  • 🟢 Added sections page & supported EffectSection (added to both sections and effects page)
  • 🟢 Added support for lower versions in search filter (v:2.5-)
  • 🟢 Added Search results counter
  • 🟢 Added support for branched version search (v:2.2-dev36)
  • 🟢 Version number will now go to the GitHub changelog link of that version when clicked
  • 🟢 Merged PR Fix Events & Classes missing requirements section in the Docs #4063
  • 🟢 Added custom Skript SyntaxHighlighting (Much faster, made for Skript, Built-in)
  • 🟢 Added stable version and more placeholders to be used later on
  • 🟢 Anchor elements Improvements
  • 🟢 Docs tab is now clickable and will open a page with all the elements
  • 🟢 Added 'New' Tab (special case of docs tab) that show all the registered syntaxes with a version filter to see the new additions since specific version
  • 🟢 Added new search filters (is:new type:cond type:expr etc.)
  • 🟢 Added syntax type on the right side
  • 🟢 Syntax left border will now depends on the type
  • 🟢 Added copy search link to allow people to paste links with custom search parameter
  • 🟢 Added 'new' badge beside new added/updated syntaxes
  • 🟢 Allow generating hooks docs if in testing mode and doc-templates folders exists (to make it easier for debugging and new releases)
  • 🟢 Added 'How to generate the docs' section to README
  • 🟢 Added Javadocs
  • 🟢 Made examples collapsible
  • 🟢 Added a template for a yet-to-come docs feature (By Addon) cell which tells which addon created this element (this is still under progress so I left it commented to finish later)
  • 🟢 Added a new header tab 'Dev Tools' for anything related to addon developement in general such as Javadocs and later on addon development tutorials maybe
  • 🟢 Added return type for expressions and functions4
  • 🟢 Searching will not look form matches in descriptions too
  • 🟢 Cookies Accept/Deny Bar
  • 🟢 Added keyword searching e4811d4 (Thanks to @Pikachu920 )
  • 🟠 Improved the search bar placeholder text
  • 🟠 Improved docs search by reading [ ] as (space) to match patterns like off[ ]hand
  • 🟠 Improved page inital loading for chromium based browsers (up to 70%) by using content-visibility css property
  • 🟠 Improved the overall style to be much easier to read and understand.
  • 🟠 Shorten the tabs list by using sub-tabs
  • 🟠 Code cleanup
  • 🟠 Fixed all broken docs links in examples and descriptions
  • 🟠 Improved the docs patterns to remove unnecessary parentheses such as [(script)] in ExprAllCommands
  • 🟠 Unified the word "colour" to be "color" for better search results and unified usage
  • 🟠 Update sections description & examples
  • 🟠 Updated docs info of hooks (required-plugins section)
  • 🟠 Fixed classes and events requiredPlugins section joining values using newline instead of ", "
  • 🟠 Unified left-over "Colour" words in ExprColorOf
  • 🟠 Search bar and search icon now have a tooltip to show some information
  • 🟠 Dimmed the white text a bit in dark mode
  • 🟠 Improve overall JS loading using 'defer'
  • 🟠 Added theme-color meta tag
  • 🟠 White theme improvements
  • 🟠 Fix black theme flicker when on white theme on load
  • 🟠 Improved Github API calls by using caches to avoid getting blocked by the API
  • 🟠 Disabled effects keywords Syntax Highlighting (standardizing keywords a little)
  • 🟠 Changed hash link from scrolling to search filter (Chrome wasn't scrolling properly)

Target Minecraft Versions: Any
Requirements: None
Related Issues:

@AyhamAl-Ali
Make parsed optional in parsed as
ac1ed7a
@AyhamAl-Ali
First Improvements Phase
ea16c56 
+ Added DarkMode (Switcher, AutoLoad from cookies)
+ Added support for lower versions in search filter (v:2.5-)
+ Added Search results counter
+ Added support for branched version search (v:2.2-dev36)

* Removed the SH for now until I implement the new one.

* Improved the overall style to be much easier to read and understand.
* Shorten the tabs list by using sub-tabs
+ Version number will now go to the GitHub changelog link of that version when clicked
@AyhamAl-Ali AyhamAl-Ali marked this pull request as draft September 4, 2021 02:32
@AyhamAl-Ali
Fixes
3b84d57 
- Fixed found results colors
- Fixed found results showing in some cases when should not
@TPGamesNL TPGamesNL added the enhancement Feature request, an issue about something that could be improved, or a PR improving something. label Sep 4, 2021
@AyhamAl-Ali
🛠 Sections + Improvements
184bbac 
+ Added sections page
- Improved page inital loading for chromioum based browsers (up to 70%) by using content-visibility css property
- Fixed searching filters regex
- Improved submenu active state
@AyhamAl-Ali
Forgot search fixes
37973b5
@AyhamAl-Ali
🚀 Another Update
b919563 
- Merged PR SkriptLang#4063
- Added more info about strings (single quotes support after v2.6)
- Fixed all broken docs links in examples and descriptions
- Improved the docs patterns to temove unnecessary parentheses such as [(script)] ex. ExprAllCommands
- Unified the word "coluor" to be "color" for better search results and unified usage
@AyhamAl-Ali
Sections update & much more fixes
5a40e85 
- Update sections description & examples
- Revert SecConditional syntax ordering changes
- Fixed more broken docs links using ../ instead of ./
- Fixed hooks docs not generating because the plugins are not installed, now they will generate if the user have /docs-template/ folder in Skript's folder OR the plugins installed
- Updated docs info of hooks (required-plugins section)
- Fixed classes and events requiredPlugins section joining values using newline instead of ", "
- Unified left-over "Colour" words in ExprColorOf
@AyhamAl-Ali AyhamAl-Ali mentioned this pull request Sep 11, 2021
Closed
@AyhamAl-Ali
🛠 SyntaxHighlighting + Improvements
465b294 
- Added custom Skript SyntaxHighlighting (Much faster, made for Skript, Built-in)
- Theme Improvements
- Fixed a padding bug causes recently in this PR
- Fixed a bug in theme switcher button in home page
- Added stable version and more placeholders to be used later on
- Anchor elements Improvements
@AyhamAl-Ali
🚀 'New' Tab and much more
2be2d9f 
This is probably the last update in this PR

- Added 'New' Tab that show all the registered syntaxes with a version filter to see the new additions since specific version
- Added new search filters (is:new type:cond type:expr etc.)
- Added syntax type on the right side
- Syntax left border will now depends on the type
- Added copy search link to allow people to paste links with custom search parameter
- Added 'new' badge beside new added/updated syntaxes
- Allow generating hooks docs if in testing mode and doc-templates folders exists (to make it easier for debugging and new releases)
- Some main.js improvements and cleaning up
- Search bar and search icon now have a tooltip to show some information
- Updated the light bulb icon to match the feel of the website
- Added 'How to generate the docs' section to README
- Dimmed the white text a bit in dark mode
@AyhamAl-Ali AyhamAl-Ali marked this pull request as ready for review September 25, 2021 03:21
@AyhamAl-Ali
Copy link
Member Author

This PR is now ready for review :)

@AyhamAl-Ali
🛠 Mobile CSS fixes
7c48499 
- Fixed new CSS not working well on mobile
- Improved CSS for mobile
@AyhamAl-Ali
🛠 Little CSS fixes
c1c9dd0
@AyhamAl-Ali
🛠 Item type text color
fae6a09
@AyhamAl-Ali
🛠 Quick improvements and fixes
cfd45cc 
- Improved new.html page versions loading (by caching versions)
- Fixed duplicated IDs check and new.html sidebar items filtering
- Fixed search link parameter decoding '+' as a space
- Fixed new search filters not showing results count
- White theme improvements
@AyhamAl-Ali AyhamAl-Ali marked this pull request as draft October 31, 2021 21:09
@AyhamAl-Ali
Copy link
Member Author

Converting to draft since I am adding more features due to the recent updates

@AyhamAl-Ali
Merge remote-tracking branch 'origin/master' into ench/docs-site-impr…
549b58e 
…ovements
@AyhamAl-Ali
Improvements
c880441 
- Fix dark mode not selected by default
- Improve hash link scroll handling
- Fix new.html versions showing empty option sometimes
- Merged SkriptLang#4348 Thanks to (@oskarkk)
- Readded (font) chat component to text.html after removing it by accident
- Fixed unnamed classes warning in docs.json 
- Fixed typo in EvtBlock
- Added missing docs info for couple classes
- Improved light off icon
- Improved white theme background color
@AyhamAl-Ali AyhamAl-Ali mentioned this pull request Nov 2, 2021
Closed
@TPGamesNL TPGamesNL added the documentation Related to Skript's official documentation. label Nov 4, 2021
@TheLimeGlass
Copy link
Collaborator

@AyhamAl-Ali conflicts need to be handled.

@TheLimeGlass TheLimeGlass self-requested a review October 15, 2022 05:37
@TheLimeGlass TheLimeGlass mentioned this pull request Oct 24, 2022
Closed
@TheLimeGlass TheLimeGlass added the 2.7 Targeting a 2.7.X version release label Oct 24, 2022
@TheLimeGlass TheLimeGlass mentioned this pull request Oct 24, 2022
Closed
@AyhamAl-Ali
Add Cookies Accept Bottom Bar
8a4bac1 
- Cleaned up functions to be in their own file to remove duplicated code in theme-switcher.js and main.js
@AyhamAl-Ali
Fix a quick error in cookies bar
2747763
AyhamAl-Ali added a commit to AyhamAl-Ali/Skript that referenced this pull request Oct 28, 2022
@AyhamAl-Ali
SkriptLang#4319 - e4cf2e1
b37bd2d
Moderocky
Moderocky approved these changes Nov 1, 2022
View reviewed changes
Copy link
Member

@Moderocky Moderocky left a comment

Choose a reason for hiding this comment

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

Approved pending reorganisation of website files.

@AyhamAl-Ali
Copy link
Member Author

Cookies Bar needs to be put in a more parent element
image

@TheLimeGlass
Copy link
Collaborator

Conflicts @AyhamAl-Ali

@TheLimeGlass
Copy link
Collaborator

TheLimeGlass commented Jan 9, 2023 •
edited
Loading

I don't think we should standardize colour to be color. It should remain colour as Skript was made in Switzerland where they use colour based on the British English. The whole world uses colour accept American English.

@TheLimeGlass
Copy link
Collaborator

Pikachu forgot to add the Keywords.class annotation lol

@TPGamesNL TPGamesNL removed their request for review January 20, 2023 09:46
@Moderocky Moderocky merged commit 523bd1e into SkriptLang:master Jan 20, 2023
@TheLimeGlass TheLimeGlass removed their request for review April 28, 2023 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bluelhf bluelhf bluelhf left review comments

@D4isDAVID D4isDAVID D4isDAVID left review comments

@TheLimeGlass TheLimeGlass TheLimeGlass left review comments

@TPGamesNL TPGamesNL TPGamesNL approved these changes

@APickledWalrus APickledWalrus APickledWalrus approved these changes

@Moderocky Moderocky Moderocky approved these changes

Assignees
No one assigned
Labels
2.7 Targeting a 2.7.X version release documentation Related to Skript's official documentation. enhancement Feature request, an issue about something that could be improved, or a PR improving something.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@AyhamAl-Ali @TPGamesNL @TheLimeGlass @oskarkk @Moderocky @APickledWalrus @D4isDAVID @bluelhf @NotSoDelayed @Pikachu920