Skip to content

Documentation update guide required #21322

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

Open
pass-lin opened this issue May 23, 2025 · 1 comment
Open

Documentation update guide required #21322

pass-lin opened this issue May 23, 2025 · 1 comment
Assignees
Labels
stat:awaiting response from contributor type:docs Need to modify the documentation type:feature The user is asking for a new feature.

Comments

@pass-lin
Copy link
Contributor

Can keras-team add a guide on how to update the documentation?
So far, I have submitted to roformerV2, modelscope download source, and Muon optimizer for keras and keras_hub projects. But the documentation doesn't seem to be updated, but I don't know how to contribute to the update of the documentation. Can keras-team provide a guide?

@dhantule dhantule added type:docs Need to modify the documentation type:feature The user is asking for a new feature. labels May 23, 2025
@dhantule
Copy link
Contributor

Hi @pass-lin, thanks for reporting this.

The documentation is autogenerated using keras-io documentation generator, for example to update the documentation for muon optimizer, you'll have update the api_master file with this

             {
                  "path": "muon",
                  "title": "Muon",
                  "generate": ["keras.optimizers.Muon"],
              }

Similarly you can update the documentation for your other contributions, please follow these instructions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stat:awaiting response from contributor type:docs Need to modify the documentation type:feature The user is asking for a new feature.
Projects
None yet
Development

No branches or pull requests

3 participants