Sibyx / django_api_forms

Declarative Django request validation for RESTful APIs

https://sibyx.github.io/django_api_forms/

MIT License

22 stars 13 forks source link

Detailed documentation #10

Open Sibyx opened 4 years ago

Sibyx commented 4 years ago

Documentation is essential part of every project (in my opinion, it's not enough to keep full example in README file - which is starting to be quite long).

My idea is to create GitHub pages using mkdocs and mkdocs-material (like in duckql-python repository) with:

[x] documentation (with motivation why we decited to create them - BooleanField is pretty interesting) for each custom field (which is not part of Django)
[x] process of validation (how normalization in processed)
[ ] nesting forms
[ ] database relationships
[x] fill method
[ ] file uploads
[ ] model forms
[ ] settings

AbhijithGanesh commented 3 years ago

Can I work on this issue? I would like to add additional documentation @Sibyx Also can this be registered for Hacktoberfest?

Sibyx commented 3 years ago

Hi @AbhijithGanesh, I was not sure If should mark this issue to Hacktoberfest or if I want it to be done by someone who didn't originally write the library. But If you want to add some additional documentation feel free to do it (I will mark your PR for Hacktoberfest). Please, let me know what part of the documentation you want to add. There are already some empty sections (it's a good start point). If you have any questions, feel free to ask. Please, do not add docs for the ModelForm, this feature is not working properly.

AbhijithGanesh commented 3 years ago

I'll add additional docs , since only the project s original contributors can write docs, I'll keep it in mind and do what I can, thank you for clarifying. I am really looking forward to contribute and I felt the documentation would be a good place to start.

Sibyx commented 3 years ago

I am looking forward to your contribution. As I said, if you have any questions, feel free to contact me or create a discussion.

Sibyx commented 3 years ago

One more thing: I am working on release 0.20.0 where will be some major changes in:

fill methods,
parser configuration.

It supposes to be finished yesterday (I am fixing the test coverage right now). So, there will be some changes in the codebase in the next few hours. This issue should not be affected, but anyway I think you should know.

AbhijithGanesh commented 3 years ago

I will not be writing docs for another 12 hours(I work on IST) so yeah. I will start once the release is done if that suits the project the best

Sibyx commented 3 years ago

30 is merged, no bigger changes are planned for the next few days, so there should not be any potential conflicts