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

Refactor README into docs #407

Closed
marksweb opened this issue Oct 8, 2020 · 3 comments
Closed

Refactor README into docs #407

marksweb opened this issue Oct 8, 2020 · 3 comments
Labels
good first issue
Milestone
2.1

Comments

@marksweb
Copy link
Collaborator

marksweb commented Oct 8, 2020

There's a branch which is quite old & didn't get too far with the task of creating sphinx docs;

https://github.com/groveco/django-sql-explorer/tree/docs

(I've merged master to sync it)

It would be ideal to refactor the README into proper docs, leaving a simple 'getting start' type overview for a README. There's far too much detail in there at the moment.
@bojanderson
Copy link
Contributor

If you're still looking for help with this. I could help.

@marksweb
Copy link
Collaborator Author

@bojanderson that would be ideal. 👍

@bojanderson bojanderson mentioned this issue Oct 12, 2020
Merged
4 tasks
@marksweb
Copy link
Collaborator Author

Resolved by #410 and #416

@marksweb marksweb added this to the 2.1 milestone Dec 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue
Projects
None yet
Milestone
2.1
Development

No branches or pull requests
2 participants
@marksweb @bojanderson