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

Revamp docs to highlight use cases and explain EMU attribution flow #115

Open
ahpook opened this issue May 9, 2024 · 1 comment
Open
Assignees
Labels
enhancement New feature or request high priority high impact improvements and fixes

Comments

@ahpook
Copy link
Contributor

ahpook commented May 9, 2024

Is your feature request related to a problem?

Right now the README in the repo dives right into how to develop the app - this is probably too much detail for the casual browser 😸

Describe the solution you'd like

The front page should probably just highlight the problem statement and show how the app works from a user perspective (maybe embed a demo video?). The how-to-develop info that's there now is all super helpful for devs but can probably move into its own file in the docs/ subdirectory.

Describe alternatives you've considered

No response

Additional context

No response

@ahpook ahpook added the enhancement New feature or request label May 9, 2024
@ahpook ahpook self-assigned this Aug 29, 2024
@ahpook ahpook added the high priority high impact improvements and fixes label Aug 29, 2024
@ahpook
Copy link
Contributor Author

ahpook commented Aug 29, 2024

Specifically lots of people are confused about the attribution flow for contributions that start off with an EMU user and then flow upstream to that user's public identity.

@ahpook ahpook changed the title Revamp docs / README to highlight use-cases & value Revamp docs to highlight use cases and explain EMU attribution flow Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request high priority high impact improvements and fixes
Projects
None yet
Development

No branches or pull requests

1 participant