chore(docs): Usage Examples

Open
#102 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by reviewing README.md and the existing usage examples it references. Update the README with more robust pointers to examples, and confirm whether the official website work is in scope before proceeding. Done means the README clearly directs users to current usage examples; website additions are described as longer-term work.

Written by the indexing model from the issue text.

Description

Documentation Userale

Copied from https://github.com/apache/flagon-useralejs/issues/450

Problem

Our usage examples are limited to our README and have fallen out of date.

Solution

Short-term: update README.md with more robust pointers to examples
Medium-to-long-term: add usage examples to official website

Dominant language
Jupyter Notebook
Stars
30
Forks
15
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/flagon

All issues in apache/flagon

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.