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

Make a docs site #58

Open
ryanhiebert opened this issue Jul 20, 2024 · 3 comments
Open

Make a docs site #58

ryanhiebert opened this issue Jul 20, 2024 · 3 comments

Comments

@ryanhiebert
Copy link
Collaborator

This package is gaining some really helpful complexity, and having a documentation site for more detailed explanation that isn't appropriate in a README may soon be wise. Our README is already getting a bit unwieldy, so a separate docs site would allow us to slim that down to only a very basic example.

@tim-schilling
Copy link
Member

I agree!

@tim-schilling
Copy link
Member

Proposed docs set up:

  • about / justification
  • installation
  • reference
  • examples
    • add field
    • remove field
  • suggested safe values for common db operations

I'm happy to source information from https://www.better-simple.com/django/2024/07/22/django-safemigrate/ where it makes sense.

@ryanhiebert
Copy link
Collaborator Author

I'd generally put reference last in the list, but yeah, those seems like good sections.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants