Comments (5)
There is currently no standalone documentation; instead, the documentation exists as popovers that open when clicking the question-mark icons within the running app.
If you believe it's appropriate, I can add this explanation to the README file. Please let me know.
from materialnet.
I think the popovers are fine for user documentation, together with #166.
Is there any kind of developer/API documentation? Potentially something automatically generated from comments in the code.
from materialnet.
I think the popovers are fine for user documentation, together with #166.
Sounds good. We are working on #166 now.
Is there any kind of developer/API documentation? Potentially something automatically generated from comments in the code.
Unfortunately, no. There is a bit of discussion in the README about some aspects of how the code is architected, but no formal documentation.
from materialnet.
I think it would be worth the time and effort investment to create a developer documentation. I don't think this is blocking for the JOSS review, but adding developer/architectural documentation would improve the long term usefulness of MaterialNet 😃
from materialnet.
I think it would be worth the time and effort investment to create a developer documentation. I don't think this is blocking for the JOSS review, but adding developer/architectural documentation would improve the long term usefulness of MaterialNet smiley
I agree, and as we continue to work on it, we will attempt to generate some dev docs. It would definitely be a help to the project overall!
from materialnet.
Related Issues (20)
- Improve UI labels and add infotags to app
- Add download link to material infopanel for CIF/POSCAR/CJSON data
- Investigate adding Crystal Toolkit renderer to crystal structure rendering options HOT 2
- Convert discovery year to a slider
- Support animated "playback" for any value, not just discovery year
- Integrate different node filtering modes into one
- Add Download CSV feature
- Add reset filter button HOT 1
- logo in night mode HOT 1
- Remove zoom slider HOT 1
- Sticky loading throbber HOT 1
- JOSS review: outdated links in "about" modal HOT 2
- JOSS Review: package.json name is "react-demo"
- JOSS Review: Example usage HOT 6
- JOSS Review: Local installation hangs HOT 3
- JOSS Review: Provide community guidelines HOT 1
- JOSS review: yarn test fails HOT 2
- Add linting infrastructure to codebase
- Fix search mode pickiness
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 materialnet.