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.

Sign up for GitHub

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

Jump to bottom

Overhaul main README #437

Open
3 tasks
johnbaldwin opened this issue Mar 2, 2022 · 0 comments
Open
3 tasks

Overhaul main README #437

johnbaldwin opened this issue Mar 2, 2022 · 0 comments
Assignees
@johnbaldwin
Labels
documentation

Comments

@johnbaldwin
Copy link
Contributor

johnbaldwin commented Mar 2, 2022 •
edited
Loading

The current README is horribly out of date and it is also serving as the changelog file, eating valuable reading real estate.

Tasks to overhaul README

WIP Doc structure

  • Overview: This section is the 30 second read. What's Figures? Is it active? Is it useful to me? Do I continue reading?

  • What is Figures? After the 30 second read, provide some more details, still brief. We ought to have architecture doc(s) and link from here

  • Getting started with Figures

  • Figures devsite

  • Installing Figures in Open edX

  • Contributing

  • Reporting bugs

  • reporting security issues
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johnbaldwin johnbaldwin

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@johnbaldwin