Feature/docs #96
Merged
Feature/docs #96
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Applies a dark theme to the documentation site using the `darkly` theme. Provides a visually appealing dark mode option. Configures colors to ensure readability and aesthetic consistency.
Adds comprehensive documentation for the `Vector4` class, outlining constructors, operators, and utility functions. Includes detailed notes on `clamp` functionality and potential ImGui integration caveats. Incorporates optional ImGui integration with explanations for correct usage and potential improvements.
Documents the `omath::collision::Ray` and `LineTracer` types, detailing their purpose, usage, and API. Includes a description of the Möller–Trumbore algorithm and provides usage examples for segment-triangle and infinite ray intersection tests. Relates to feature/docs
Adds comprehensive documentation for the pattern scanning API. Details parsing behavior, complexity, and usage examples. Includes troubleshooting tips and minimal test sketches. Clarifies edge-case handling and implementation notes.
Moves various image files demonstrating libomath’s usage and featuring artwork from showcases to the improved `docs/images` structure to reorganize the project's documentation in a logical and maintainable fashion. This change ensures consistency and simplifies updating documentation assets.
Adds documentation for the `omath::ViewAngles` struct, clarifying its purpose, common usage patterns, and the definition of the types of pitch, yaw and roll. Also, adds short explanations of how to use ViewAngles and what tradeoffs exist between using raw float types and strongly typed Angle<> types.
Widens the navbar container to accommodate more content. Adjusts padding of navbar items for tighter spacing. Prevents line wrapping and enables horizontal scrolling on smaller screens.
Owner
Author
|
@copilot add additional docs for engines into docs folder using .md and same style |
Contributor
|
@orange-cpp I've opened a new pull request, #97, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: orange-cpp <59374393+orange-cpp@users.noreply.github.com>
Add documentation for game engine math modules
Owner
Author
|
@copilot overall improve documentation |
Contributor
|
@orange-cpp I've opened a new pull request, #98, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: orange-cpp <59374393+orange-cpp@users.noreply.github.com>
Co-authored-by: orange-cpp <59374393+orange-cpp@users.noreply.github.com>
Comprehensive documentation overhaul with guides, tutorials, and cross-references
Deletes the `dark-overrides.css` file. This file appears to have been superseded by other theming mechanisms and is no longer needed. Its presence was causing potential conflicts.
Updates several documentation titles to a more consistent format. Changes include renaming "Frequently Asked Questions (FAQ)" to "FAQ", "Getting Started with OMath" to "Getting Started", "Troubleshooting Guide" to "Troubleshooting", and "OMath Tutorials" to "Tutorials". ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.