chunky-dev / docs Goto Github PK

Auto Python code execution and insertion to the original Markdown source. Any Python codes in a fenced code block of original Markdown source are executed. This process is performed by a Jupyter client. In addition to this code execution, Pheasant can automatically number headers, figures, tables, etc. See the Pheasant official site at Pheasant Home

WebP offers file sizes that are around 30% smaller than JPEG without a quality gap.

Need to explore if this holds up and migrate everything over.

WebP Browser Support

A temporary solution would probably be to simply number the figures per-page. E.G., For each page, there is Figure 1, Figure 2, Figure 3, etc. References to figures in other pages would still work; they would just be, "see this image" for...

• Expansion on Ray/Path Tracing section - This section is short and relies a bit too much on external sources and videos. Ideally we should better describe how it works with the external sources as additions.

chunky-dev/chunky#1192

Testing if new discord webhook works.

Documenting the changes between the different filter modes would be nice.

The Introduction article requires further refinement.

• #68
• Samples Per Pixel (SPP) - Update gif with a smoother animation with more frames
• Merge NEE/ESS stuff together
• Emitter Sampling Strategy (ESS) - Section is confusing. Probably needs diagrams to explain the complex nature of ESS.
• Materials - Need to add a section on various material properties and how they function (in context). This is intended to replace some of the content within Reference - Render Controls - Materials as that article should just be for the UI and short descriptions.
• Image formats and color - This section does not really fit here. Maybe we should move some of the content to Reference - Scene Format and other parts to Reference - Render Controls - Advanced.

Given the scope of the article, and the changes that may be required, I would not be against the sub-division of the article. Please use this issue to further expand on any issues with the article and your suggestions.

• The Controls headers used across User Interface can be considered redundant and unnecessary. It also increases depth for no real reason or benefit.
• Suggest renaming 2.5.0 controls to Upcoming Changes. At least until we figure out multi-versioning of some description.
• Longer pages, like Render Controls - Camera, should make more use of subsections with headers to further aid navigation around the page. for example presets & camera selection(?), position & orientation, projection, depth of field/focusing.
• We should remove/reduce line breaks, ie --- as they do look a bit messy. These exist throughout the docs so a careful comb is required.
• "The Postprocessing tab, which is the eighth tab in the left control panel," - Given the order and number of tabs changes often we probably shouldn't number them. As long as we are clear on the names of the tab this will reduce work.

Issue with #85

When docs are built for a particular Chunky version, pages that are excluded from the build are not shown in the nav. However, when the page that was excluded is the previous or next page, the Next/Previous button at the bottom of the page still points to that excluded page, and clicking that button leads to a 404 error.

An example at the time of this writing is this page: https://chunky-dev-docs-pr-85.surge.sh/docs/reference/user_interface/chunky_gui/

Click the Next button at the bottom of the page to reproduce the issue.

We incorrectly link from https://chunky-dev.github.io/docs/reference/user_interface/render_controls/advanced/ BVH to Scene Format Octree. We need a place to describe the BVH.

https://chunky-dev.github.io/docs/reference/introduction/path_tracing/#bounding-volume-hierarchy-bvh Is probably the best place but the description is limited.

Update gramma for https://chunky-dev.github.io/docs/reference/user_interface/render_controls/advanced/ BVH SAH

"the packing of the bvh is explained in the javadocs for whatever the abstract class was called"

Need to add new experimental plugin to list Chunky-CPUNativeOctree ensuring to note requirements and possible issues.

Bloom, Excel and JPEGXL plugins are all attributed to Redox (me) even though they are all by aTom3333. Their links are correct however the text is incorrect.

chunky-dev/chunky#1082

https://chunky.llbit.se already automatically redirects to https://chunky-dev.github.io/docs/, but since the site structure was different on the old site, broken URLs are often generated when redirected to any page other than the home page. The mkdocs.yml file should be able to handle this since the redirects plugin is already in use.

Need to wait for new Pyyaml version that supports Cython3 or we need mess around with the suggested workarounds listed on yaml/pyyaml#724

This issue is a placeholder used to discuss the gallery. Please use the form to submit renders. Typically, chosen renders will end up in the Gallery however some may end up on the Index/homepage.

Please complete the following form

Requirements:

• Must be rendered using Chunky 2.4.0+

• Must provide a title/description, a username to have the render listed under, and credits for map (if rendering a map you did not create yourself) in form of a URL/link.

Nice to haves:

• Renders that showcases advanced material features like metalness and roughness well.

These requirements and requests may change as more input is given. We will tag people if changes are needed to their submission.

It would be very helpful for the plugins page to have anchor tags so I could directly link to certain plugins. Such as https://chunky-dev.github.io/docs/plugins/plugins#denoiser.

With the merge of chunky-dev/chunky#1292, the installation just got one step easier. We should probably mention that and move the manual JavaFX installation into troubleshooting.

Material for MkDocs supports versioning by using mike as a provider. Unofficially, we can hijack this functionality by adding our own versions.json.

Option 1 - mike: Python utility that reuses previously-deployed docs for a given version. Not very good for multi-branch software like ours.

Option 2 - mkdocs-monorepo-plugin: Allows for multiple docs/ folders and navigations.

Markdown tables do not adjust for mobile devices even when there is room to do so.

Pixel 5

Pixel 5

Mozilla Observatory summary

While we likely do not need to improve site security given the nature of the content we are hosting it may still be a fun project for someone to undertake.

chunky-dev/chunky#1172

The site icon is the default material docs icon. This should probably be switched to the Chunky Logo.

Need to link Lighting: ESS To Intro: Emitter Sampling Strategy (ESS)

• Opposed to flooding the UI reference pages with too much information we should link back to the Intro pages to expand on things. Feel free to suggest other links that may be required on this issue.