Skip to content
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

Merged
merged 6 commits into from
Oct 27, 2023
Merged

[WIP] Developer docs #228

merged 6 commits into from
Oct 27, 2023

Conversation

Freymaurer
Copy link
Collaborator

@Freymaurer Freymaurer commented Oct 9, 2023

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

@Freymaurer Freymaurer requested a review from HLWeil October 9, 2023 14:18
Copy link
Member

@HLWeil HLWeil left a 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.
Copy link
Member

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?

@HLWeil
Copy link
Member

HLWeil commented Oct 10, 2023

Maybe split ARC.md into IO.md and API.md?

@Freymaurer
Copy link
Collaborator Author

@HLWeil can you review this, so we can just release a new beta version and i will add some more docs soon?

@Freymaurer Freymaurer requested a review from HLWeil October 27, 2023 14:14
Copy link
Member

@HLWeil HLWeil left a 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.

@HLWeil HLWeil merged commit 68b3919 into main Oct 27, 2023
2 checks passed
@Freymaurer
Copy link
Collaborator Author

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants