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

Update the reference for documentation #18

Closed
greglucas opened this issue Apr 24, 2020 · 3 comments · Fixed by #19
Closed

Update the reference for documentation #18

greglucas opened this issue Apr 24, 2020 · 3 comments · Fixed by #19
Assignees

Comments

@greglucas
Copy link
Member

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:

<markdown [src]="'https://raw.githubusercontent.com/SWxTREC/vector-code/master/docs/DOCUMENTATION.md'"></markdown>

Of course, that is documentation of the API, not the calculation code... So, it depends on what documentation we actually want on the website.

@jennyknuth
Copy link
Collaborator

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?

@greglucas
Copy link
Member Author

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.

@jennyknuth
Copy link
Collaborator

jennyknuth commented Apr 25, 2020 via email

@jennyknuth jennyknuth linked a pull request May 20, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants