Comments (8)
I'd love to contribute to the documentation as I use the engine and learn more about it! Are you planning on adding this into the main readme or a readme in the docs folder?
from noa.
No idea really 😁 Probably there'd be too many docs to go in the main readme, so a folder full of md
files that link to each other might be best. But really anything that parses jsdoc comments and makes a nice readable result would be okay with me. I worked on this once (see here) but something broke and I didn't have time to get into it.
from noa.
Awesome, ill start adding documentation as I continue to work on my project, ill let you take a look and see what you think at some point. I've already built a tree diagram for several functions just for myself so we could add that into the documentation as well to show the function hierarchy for different functionalities. I simply did it for my own sanity when trying to better understand how things like chunks are managed in the engine. ;O
from noa.
Sorry, I should clarify - what I was specifically hoping for is help with a JSDoc-style build system. JSDoc is the thing where you add specially formatted comments to the code, like:
/**
* @param foo: [string] the name of the thing
*/
and then use some library that parses all the code and auto-generates an API reference of some kind.
I had something like this working at some point, based on a library called markdox, but something broke and I wasn't that happy with it anyway, and haven't had time to look for something better.
from noa.
Wow I had no idea that was even a thing, that's pretty cool. I'll have to read about how that works.
from noa.
It doesn't seem like this has been worked on so far.
Would this do what you want @andyhall?
https://github.com/jsdoc2md/jsdoc-to-markdown
from noa.
Typedoc might be useful (there's a supported Webpack plugin), but it would take switching the code to Typescript first.
from noa.
Newest build in the #dev branch now has this partly working - it uses jsdoc-to-markdown
(thanks @2ajoyce !) and builds reasonably sane output. But some comments could use work, so any doc fix PRs are very welcome!
To use check out the dev branch, do npm i
, and then npm run doc
should rebuild API.md
.
from noa.
Related Issues (20)
- Is there any way to use this as an es6 module? HOT 10
- Support gamepad input
- Outdated comment + note on blockMesh registration HOT 2
- Alpha blended mesh ordering issue HOT 2
- Terrain remeshing bug when block is neither solid nor opaque HOT 3
- Custom voxel occasionally leaves one side after removal. HOT 4
- UV offsets wrapping at edges of blocks HOT 2
- object meshing bug HOT 6
- Meshing with non-opaque blocks is incredibly slow + block textures with alpha dont work HOT 4
- custom renderMaterial performance (for animated textures) HOT 2
- Supporting noa HOT 2
- Does NOA support child meshes? HOT 3
- webgpu? HOT 2
- How to define new objects in NOA engine. HOT 5
- Optimal octreeBlockSize
- What is the best way to manually build worlds? HOT 2
- render all blocks even if covered HOT 1
- How to import an obj model?
- refresh the registry on the go HOT 2
- Making a set world.
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from noa.