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

Documentation Improvements #476

Merged
merged 30 commits into from
Dec 8, 2022
Merged

Documentation Improvements #476

merged 30 commits into from
Dec 8, 2022

Conversation

guusw
Copy link
Member

@guusw guusw commented Dec 6, 2022

Preview

As requested, split #472 into just the structure/technical changes, which are included here.

  • Improved search (terms like ">=", ">>", "UI Context", "UI.Context", "Context" all work)
  • Compact shard IO/Parameter overview
  • Generate enum documentation and per-value help text
  • Add section about how to read the shard documentation (docs\reference\shards)
  • Type section cleanup to use the new type format
  • Type section cleanup to use the term "Sequence" instead of "Array"
  • Type section cleanup to use the term "Shard" and "[ Shard ]" instead of ShardRef
  • Move shards to "Reference" section
  • Move "shards introduction" to the "Learn" section
  • Add image outputs to samples, e.g. in GFX.Render

@guusw guusw changed the title Guus/doc improvements Documentation Improvements Dec 6, 2022
@guusw guusw force-pushed the guus/doc-improvements branch from 4959be9 to 36b13c7 Compare December 6, 2022 10:04
@guusw
Copy link
Member Author

guusw commented Dec 6, 2022

@Kryptos-FR To address the comments from the other PR.

I moved the pages to more clearly separate where the reference is and which pages go into depth (the learn section), I think it's good to have them separate. Even if it's a work in progress, it should be fine to move I believe.

For the parameter tables, the only HTML I added is to add a <div class="sh-parameters" markdown="1"> outer class for css, I looked but there didn't seem to be a way to add a class to a markdown table directly (Python-Markdown#312)

Heres the table without being able to apply custom css to it, I think it's necessary to make it look reasonable
TableDiff

Copy link
Member

@sinkingsugar sinkingsugar left a comment

Choose a reason for hiding this comment

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

So far so good, I think it was needed to have enum descriptions.
CI failing though.

@guusw
Copy link
Member Author

guusw commented Dec 6, 2022

One thing to note is that I didn't implement attaching descriptions for rust enums, I think we can parse annotations in the decl macros but for now I left them empty from rust

@guusw guusw self-assigned this Dec 6, 2022
@guusw
Copy link
Member Author

guusw commented Dec 6, 2022

I see you commented on the other PR for things that are now split into this PR, but I'll comment over there (#472)

@guusw guusw mentioned this pull request Dec 6, 2022
9 tasks
@codecov
Copy link

codecov bot commented Dec 6, 2022

Codecov Report

Merging #476 (960da23) into devel (4e27fdf) will increase coverage by 0.00%.
The diff coverage is 87.25%.

@@           Coverage Diff           @@
##            devel     #476   +/-   ##
=======================================
  Coverage   81.24%   81.25%           
=======================================
  Files         218      219    +1     
  Lines       28789    28834   +45     
=======================================
+ Hits        23389    23428   +39     
- Misses       5400     5406    +6     
Impacted Files Coverage Δ
src/core/foundation.hpp 86.10% <ø> (ø)
src/core/shards/json.cpp 36.50% <0.00%> (+0.12%) ⬆️
src/core/shards/math_ops.hpp 95.65% <0.00%> (+1.02%) ⬆️
src/core/shards/wires.cpp 85.74% <ø> (ø)
src/extra/gfx/material.cpp 89.18% <ø> (ø)
src/extra/gfx/shards_types.hpp 100.00% <ø> (ø)
src/core/ops_internal.cpp 77.39% <90.76%> (+1.48%) ⬆️
include/shards.hpp 95.23% <100.00%> (+0.01%) ⬆️
include/utility.hpp 90.74% <100.00%> (+0.13%) ⬆️
src/core/ops_internal.hpp 100.00% <100.00%> (ø)
... and 6 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@guusw guusw force-pushed the guus/doc-improvements branch from e090532 to bb42398 Compare December 7, 2022 10:40
@guusw guusw force-pushed the guus/doc-improvements branch from 7e249d6 to 960da23 Compare December 7, 2022 16:24
@guusw guusw merged commit 9e056a0 into devel Dec 8, 2022
@guusw guusw deleted the guus/doc-improvements branch January 12, 2023 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants