docs: dark theme by default and fix custom event examples#108
Conversation
- Add custom NaturalDocs style that defaults to Dark theme (with Light/Auto/Black still available via the theme switcher) - Replace CBA macros with expanded "OCAP_customEvent" string in examples so they are usable from external mission scripts - Add missing event examples: contested, endMission string variant, and custom event names via the default handler - Remove duplicate OCAP_customEvent doc block from fnc_addEventMission
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the project's documentation by introducing a default dark theme for improved readability and user experience. It also significantly refines the examples for custom events, making them more accessible and practical for users by removing macro dependencies and providing a broader range of use cases. These changes collectively aim to improve the clarity and usability of the project's documentation. Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request focuses on improving the project's documentation. It introduces a new NaturalDocs style to default to a dark theme, enhancing user experience. The documentation examples for custom events have been updated to be more user-friendly by replacing macros with their expanded string values, making them directly copy-pasteable. Additionally, more examples have been added for completeness, and duplicated documentation has been removed by referencing a single source of truth. These changes are well-implemented and improve the overall quality and usability of the documentation.
Summary
OCAP2) that defaults to Dark theme, with Light/Auto/Black still available via the theme switcherQGVARMAIN(customEvent)) with the expanded"OCAP_customEvent"string in examples so they're copy-pasteable from external mission scriptscontested, string-onlyendMission, and custom event names via the default handlerOCAP_customEventdoc block fromfnc_addEventMission.sqf(now a single-line reference to the handler)Test plan
fnc_handleCustomEventdocs page shows all examples with expanded event names