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

Wrote starting doc about hydra-python-core library #55

Closed
wants to merge 1 commit into from
Closed

Wrote starting doc about hydra-python-core library #55

wants to merge 1 commit into from

Conversation

de-sh
Copy link
Contributor

@de-sh de-sh commented Jun 23, 2019

Solves #54

This is a starting doc mostly copied from the relevant repo README.

Would love to hear opinions about how to better present same.

@Guttz
Copy link
Collaborator

Guttz commented Jun 26, 2019

I guess this is also useful, but what I had in mind with #54 was detailing how to use Core to interact with an apidoc. Ex.:

To initialize:
api_doc = doc_maker.create_doc(apidoc)

To get a list of Supported Properties:
api_doc.parsed_classes[collection_type][class].supportedProperty

To get a list Supported Operations:
api_doc.collections[endpoint][collection].supportedOperation

Along other basic actions which are useful when interacting with the apidoc. We currently have some different materials that cite doc_maker like Chris and Akshay's posts at
https://www.hydraecosystem.org/seasonofdocs-2019.

@de-sh
Copy link
Contributor Author

de-sh commented Jun 26, 2019

Awesome, getting to it!

@xadahiya
Copy link
Member

We probably want to main sections here.

  • A section explaining how the library can be used to write new a Hydra Vocab
  • Another section explaining how the library can be used to interact with the APIDoc just like @Guttz said.

@de-sh
Copy link
Contributor Author

de-sh commented Jul 10, 2019

We probably want to main sections here.

  • A section explaining how the library can be used to write new a Hydra Vocab

Ok, so this will be more like in the tutorial sense, like how a "make your own app" article goes in most framework documentation.

@xadahiya
Copy link
Member

xadahiya commented Aug 2, 2019

Closing this. @de-sh Please make a PR once you've something substantial

@xadahiya xadahiya closed this Aug 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants