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

Improve documentation markdown files #165

Open
brookwander opened this issue Sep 20, 2022 · 0 comments
Open

Improve documentation markdown files #165

brookwander opened this issue Sep 20, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@brookwander
Copy link
Collaborator

Use cases:

  1. Adding info for people who are using catlas outside of "normal operation"

Scope:
What will be done:

  1. Make an item in advanced use to include making a bulk db
  2. Making documentation describing how to compare catlas against custom DFT (to be run by user)
  3. Making documentation for what to do when your adsorbate is ood (making a custom pkl file)

What will not be done:

  1. Any actual coding to support the above points

Execution plan:
All to be done solo by Brook. This is a low priority item.

Consider any problems / risk:
None! Just documentation

@brookwander brookwander added the documentation Improvements or additions to documentation label Sep 20, 2022
@brookwander brookwander self-assigned this Sep 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant