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

Add the examples/client_example to RTD #1716

Closed
kairoaraujo opened this issue Dec 8, 2021 · 1 comment · Fixed by #1772
Closed

Add the examples/client_example to RTD #1716

kairoaraujo opened this issue Dec 8, 2021 · 1 comment · Fixed by #1772
Assignees
Labels
1.0.0 blockers To be addressed before 1.0.0 release
Milestone

Comments

@kairoaraujo
Copy link
Collaborator

Description of issue or feature request:
An example can be a good start point for those reading the RTD Updater.
We could add the client_example in a way it can be explored by who wants to implement a client.

Current behavior:
The ngclient.Updater RTD does not have an example or point to the examples folder. The event folder is available only in the source code.

Expected behavior:
Easy landing or example demonstration to who wants to implement a client.

@jku jku added the 1.0.0 blockers To be addressed before 1.0.0 release label Jan 12, 2022
@jku jku added this to the Sprint 15 milestone Jan 12, 2022
@lukpueh
Copy link
Member

lukpueh commented Jan 12, 2022

I think a sensible quick fix would be to just add a phrase or paragraph on RTD that links to the directories examples/client_example and examples/repo_example, akin to how it's done in the repo main readme.

This could be part of the RTD API reference and/or in a new top-level RTD "examples" page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.0.0 blockers To be addressed before 1.0.0 release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants