A magician never reveals his secrets but this web app does exactly that.
The app is deployed here.
To organise the documentation, I based myself on this article. The gist of it is you have to split your documentation based on what it tries to accomplish. There is a total of four distinct types of documentation. The first type are explanations which try to answer WHY things were done the way they're done. The second type are how-to guides. These are more like recipes. If you want a quick answer HOW to solve a specific problem, this is where you should look. The third type are tutorials. These will try to seduce you to use the app. They answer WHY in the sense of, why should I even bother with this? The fourth and last type are references. These just describe.
The documentation can be found in the doc folder.
I'm planning on building multiple prototypes. In each prototype I try to use something new Angular offers. The first prototypes roughly follow the try it Angular tutorial and have already been implemented.
- show tricks by magician (components)
- detail page per magician (components)
- fetch some tricks (backend and services)
- add your own magician
Next steps will be to add more content using things already learned, update the form so more data can be input. This will also be the right time to add a more permanent database.
Open enhancements, issues, bugs,... are logged in the GitHub issues section.