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

Move documentation from tensorflow.org #298

Open
5 tasks
codesue opened this issue Oct 16, 2023 · 0 comments
Open
5 tasks

Move documentation from tensorflow.org #298

codesue opened this issue Oct 16, 2023 · 0 comments
Labels
contributions welcome This issue is ready to be worked on documentation Improvements or additions to documentation maintenance Chores and process improvements

Comments

@codesue
Copy link
Collaborator

codesue commented Oct 16, 2023

What happened?

Now that Model Card Toolkit is a community project, guides and API documentation will be removed from tensorflow.org and hosted elsewhere. There will still be an overview of MCT on tensorflow.org, and it will link to the new documentation site.

What is the expected behavior?

There should be a Model Card Toolkit documentation website that's separate from tensorflow.org.

To make this happen, we need to:

  • Choose a platform (e.g. Read the Docs) since GitHub Pages is not enabled for this organization
  • Choose a documentation tool (e.g. Sphinx or MkDocs)
  • Update existing documentation to work with the chosen tool
  • Automate building the docs (e.g. add a workflow)
  • Update the contributing guide

Resources:

@codesue codesue added documentation Improvements or additions to documentation contributions welcome This issue is ready to be worked on maintenance Chores and process improvements labels Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributions welcome This issue is ready to be worked on documentation Improvements or additions to documentation maintenance Chores and process improvements
Projects
None yet
Development

No branches or pull requests

1 participant