-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[WIP] Developer docs #228
[WIP] Developer docs #228
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should add direct links from the main README.md
to the .md
files located in the docs folder.
Similar to https://github.com/fslaborg/FSharp.Stats
|
||
## Write | ||
|
||
In .NET you can use [ARCtrl.NET][1] to handle any contract based read/write operations. For this documentation we will extract the relevant ARCtrl.NET functions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we actually also add documentation for ARCtrl.Net here?
Maybe split ARC.md into |
@HLWeil can you review this, so we can just release a new beta version and i will add some more docs soon? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good starting point for the documentation. We should keep in mind to reorganize a bit (especially root README.md) when we get a little bit more bulk.
Damn! I forgot to push my last changes to README.md! |
Starting to write developer docs. Until Fable allows keeping comments, auto generated source code docs do not seem like a valid option.
@JonasLukasczyk please have a look at the js code implementation
/docs/scripts_js/ARC.js
and please just sent me all of your ARCtrl code implementations.@HLWeil tell me if you are okay with the structur, file placement, etc.
closes #223
closes #231
closes #233
closes #234
closes #232
closes #114