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

Single source of truth for documentation #17

Open
jennyknuth opened this issue May 18, 2020 · 1 comment
Open

Single source of truth for documentation #17

jennyknuth opened this issue May 18, 2020 · 1 comment

Comments

@jennyknuth
Copy link
Contributor

this file: https://github.com/SWxTREC/vector-code/blob/master/docs/DOCUMENTATION.md is now redundant with this file: https://github.com/SWxTREC/vector-api/blob/master/README.md.

Since the content of this documentation now goes with the API, I suggest we either remove this file or change its purpose and content to document the model code.

If at some point the the model code is documented, that information can go here and we can once again display it on the front end.

@greglucas
Copy link
Member

I agree, this is not needed anymore because this "code" repo doesn't have any API information and it isn't needed. It should probably be removed altogether.

Your suggestion about actually documenting the model code is a good one, which should probably be in the README file, not a separate DOCUMENTATION file.

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

No branches or pull requests

2 participants