open-feature / open-feature/openfeature.dev
[DOC] add init/shutdown documentation
Open
Nobody has claimed this yet.
contribfest
documentation
good first issue
v0.6.0
- Dominant language
- TypeScript
- Stars
- 65
- Forks
- 117
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 41
Description
Change in the documentation
We need to initialization/shutdown documentation to the evaluation API and provider docs.
It should include:
- provider updates:
- explanation of initialize/shutdown functions, with code samples
- evaluation API updates:
- explanation of API shutdown
- links to events for explaining how to register handlers for
PROVIDER_READY/ERROR.
NOTE: we may want to wait for at least one SDK implementation so we can have code examples.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the evaluation API and provider documentation pages linked in the issue, then review an SDK implementation if available for accurate initialization and shutdown examples. Done means both pages explain the requested lifecycle functions, include provider code samples, describe API shutdown, and link to event registration for PROVIDER_READY and ERROR.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100