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

Check Translator Developers Documentation for Accuracy #24

Open
capasfield opened this issue Jan 30, 2023 · 4 comments
Open

Check Translator Developers Documentation for Accuracy #24

capasfield opened this issue Jan 30, 2023 · 4 comments

Comments

@capasfield
Copy link

capasfield commented Jan 30, 2023

We need to set up our new ‘Developers’ for success. They will need to use the Translator Developers Documentation.

We need one (or more) member (or members) from each team to check the current Translator Developer Documentation site for completion and accuracy.

Please spend a short time (roughly 15-30 minutes) assessing the information. The target for editing are the primary content which are markdown documents in the docs subfolder of this repository.

See also issue #41.

Please make issues in this repo for any comments/suggestions (with pull requests if you ambitious).

Reach out to Richard (SRI) on Slack with questions.

@codewarrior2000
Copy link
Contributor

codewarrior2000 commented Mar 21, 2023

After a review for completeness, here are a few places found to need more fleshing out:

  1. https://ncatstranslator.github.io/translator-developer-documentation/guide-for-developers/tutorials/workflows/
    Workflows and Operations Tutorials REMOVED from repo - see below
    T.B.A.



  2. https://ncatstranslator.github.io/translator-developer-documentation/faq/
    What I want to know is...
    T.B.A.

  3. https://ncatstranslator.github.io/translator-developer-documentation/architecture/ui/
    Andy Crouse et al to elaborate.

  4. https://ncatstranslator.github.io/translator-developer-documentation/architecture/
    System design (overview), document section at architecture/index.md#system-design-overview T.B.A. (Tim)

  5. https://ncatstranslator.github.io/translator-developer-documentation/architecture/kp/service_provider/
    Service Provider, document at architecture/kp/service_provider.md A related issue Service Provider documentation #44 is created for follow up by the Biothings team.

  6. 


https://ncatstranslator.github.io/translator-developer-documentation/guide-for-developers/details/
    Docs » Developer Guide » The Full Monty...REMOVED from repo - see below

saramsey added a commit to RTXteam/translator-developer-documentation that referenced this issue Mar 29, 2023
saramsey added a commit to RTXteam/translator-developer-documentation that referenced this issue Mar 29, 2023
@saramsey
Copy link
Contributor

saramsey commented Mar 29, 2023

Team Expander Agent has submitted a PR (#38) for this issue. Note, our PR includes additional Markdown files describing ARAX and RTX-KG2, since it appears that this repo is replacing github.com/NCATSTranslator/Translator-All.wiki.git.

@RichardBruskiewich
Copy link
Collaborator

Team Expander Agent has submitted a PR (#38) for this issue. Note, our PR includes additional Markdown files describing ARAX and RTX-KG2, since it appears that this repo is replacing github.com/NCATSTranslator/Translator-All.wiki.git.

Thanks @saramsey

@RichardBruskiewich
Copy link
Collaborator

RichardBruskiewich commented Jul 5, 2023

Page (and nav menu reference) for item 6 removed as superfluous (for now). https://translator-developer-documentation.readthedocs.io/en/latest/guide-for-developers/details/
Docs » Developer Guide » The Full Monty...

Also removed https://translator-developer-documentation.readthedocs.io/en/latest/guide-for-developers/tutorials/workflows/ as not really needed (main page on workflow is good enough for now)

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

4 participants