-
Notifications
You must be signed in to change notification settings - Fork 0
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
Update the reference for documentation #18
Comments
We could have both kinds of documentation on the website: calculator and api. The calculator documentation would be for people interested in running the calculator and understanding what that involves and what the results mean and the api documentation for people who want to run the calculator programmatically. What do you think? |
That'd be fine with me. I'm not sure how you'd want to lay that out in your webpage then though. Multiple headings and embed the links below them? I also don't have the documentation to the calculation code. That is currently just a link to the thesis I think. |
Under documentation there could be two tabs: calculator and api, and each tab would render (display) the appropriate markdown file.
… On Apr 24, 2020, at 4:09 PM, Greg ***@***.***> wrote:
That'd be fine with me. I'm not sure how you'd want to lay that out in your webpage then though. Multiple headings and embed the links below them? I also don't have the documentation to the calculation code. That is currently just a link to the thesis I think.
—
You are receiving this because you were assigned.
Reply to this email directly, view it on GitHub, or unsubscribe.
|
We moved the API over to its own repository, so now the most up-to-date API documentation is over there.
https://github.com/SWxTREC/vector-api
Should we link to that document instead of the current vector-code repository?
We would need to update this line:
vector/src/app/containers/docs/docs.component.html
Line 2 in cab86dc
Of course, that is documentation of the API, not the calculation code... So, it depends on what documentation we actually want on the website.
The text was updated successfully, but these errors were encountered: