Skip to content
This repository has been archived by the owner on Sep 27, 2024. It is now read-only.

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
Contributor

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 subscribe to this conversation on GitHub. Already have an account? Sign in.
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