chunky-dev / docs Goto Github PK
View Code? Open in Web Editor NEWChunky website and documentation.
Home Page: https://chunky-dev.github.io/docs/
License: Other
Chunky website and documentation.
Home Page: https://chunky-dev.github.io/docs/
License: Other
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.
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...
Testing if new discord webhook works.
Documenting the changes between the different filter modes would be nice.
The Introduction
article requires further refinement.
Reference - Render Controls - Materials
as that article should just be for the UI and short descriptions.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.
Controls
headers used across User Interface
can be considered redundant and unnecessary. It also increases depth for no real reason or benefit.2.5.0 controls
to Upcoming Changes
. At least until we figure out multi-versioning of some description.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
.---
as they do look a bit messy. These exist throughout the docs so a careful comb is required.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.
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:
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.
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.
Need to link Lighting: ESS To Intro: Emitter Sampling Strategy (ESS)
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.