patreon / nion Goto Github PK
View Code? Open in Web Editor NEW๐ต Declarative API Data Management Library built on top of redux ๐ต
License: MIT License
๐ต Declarative API Data Management Library built on top of redux ๐ต
License: MIT License
There's some things in the /docs folder that haven't been touched in 10 months, are aren't linked to from the Readme.
what do they do? what are they for? right now there's a bunch of stuff that can be tossed in willy-nilly... what about append
?
This issue was created automatically. See associated PR for details.
It's a totally valid and well-tested option, but it's missing from the type definition file.
This relates to #82. Documentation on nion is difficult to navigate, and often results in users old and new being forced to read the source code of nion. Here is a plan to solve this by streamlining the docs.
At the center of this refresh is a single Markdown file that is designated the Walkthrough. The Walkthrough is what the README
file should link to at the end of the "In a nutshell" section. It should:
In essence, it's a fancier version of the index to the ./docs
directory.
Note: all links to the repo are pinned to the SHA-1 95ffcdc, which is master
at the time of writing.
Rename Getting Started to "Setup and Configuration". This doc is not a required read for someone working on a codebase that already uses nion.
Create the Usage file. It will illustrate the three forms of nion: hook, HOC, and decorator. See #110 for work in progress.
Create the Walkthough file. Its tentative name is index.md
and its tentative H1 heading is "Getting Started on nion".
Merge nion api into Declarations.
Create a hooks version of Examples.
Merge How nion works into nion core and rename to "Internals". Both pages document nion internals; they differ by how deep of a dive they take the reader. Divide the page by section to delineate shallow snorkeling from deep dive.
Ensure Glossary is up-to-date
When #107 merges, we will effectively have a single source of authority for API usage. This paves the way for using an automated tool to generate documentation from code, e.g. extracting JSDoc blocks into neat pages. This would let us semi-automate the Glossary and Declaration docs so that they match the type definitions exactly.
The order of the steps outlined in Overview is merely a suggestion. Furthermore, the Walkthrough itself should be continuously updated as various pages are merged, rewritten, and reorganized.
None of this is set in stone; comments are always welcome.
per @mikejonas, it seems as if the refToDelete
meta key causes the entity to be deleted to just be subbed out with undefined
rather than being filtered out of lists... this is incorrect behavior
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.