Skip to content

Refactor Getting started docs#665

Open
kondratevdev wants to merge 15 commits intomasterfrom
refactor-getting-started
Open

Refactor Getting started docs#665
kondratevdev wants to merge 15 commits intomasterfrom
refactor-getting-started

Conversation

@kondratevdev
Copy link
Copy Markdown
Collaborator

I have made things!

Checklist

  • I have double checked that there are no unrelated changes in this pull request (old patches, accidental config files, etc)
  • I have created at least one test case for the changes I have made
  • I have updated the documentation for the changes I have made

Related issues

@kondratevdev kondratevdev force-pushed the refactor-getting-started branch from 89d981d to 41578eb Compare March 15, 2026 14:27
@kondratevdev kondratevdev changed the title Refactor getting started Refactor Getting started docs Mar 15, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (93f3387) to head (7471670).

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #665   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          285       285           
  Lines        11862     11862           
  Branches       403       403           
=========================================
  Hits         11862     11862           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kondratevdev kondratevdev force-pushed the refactor-getting-started branch from 75325f7 to d032800 Compare March 17, 2026 09:29
@kondratevdev kondratevdev marked this pull request as ready for review March 17, 2026 09:36
@kondratevdev kondratevdev requested a review from sobolevn March 17, 2026 09:40
:caption: views.py
:language: python
:linenos:
:lines: 1-16
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need all imports here? Maybe we can just create another file with the minimal setup?

from dmr import Body, Controller, Headers
from dmr.plugins.msgspec import MsgspecSerializer

are not really required.

``POST /api/user/`` with a JSON body and the ``X-API-Consumer`` header.


Next steps
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like that the swagger part is gone, it should be in the first example.

Also, this part is also gone:

if __name__ == '__main__':
    # Use `python THIS_FILE_NAME.py runserver` to run the example.
    # Then visit `http://localhost:8000/docs/swagger` to view the docs.
    execute_from_command_line(sys.argv)

We need to get the working app by the end of this guide. And now there's nothing we can actually run and test.

Things to fix:

  1. Swagger
  2. manage.py
  3. settings.configure

@kondratevdev kondratevdev force-pushed the refactor-getting-started branch from 3fe5544 to 5b14e60 Compare March 18, 2026 09:09
@kondratevdev kondratevdev force-pushed the refactor-getting-started branch from 2c1f48b to 6466f34 Compare March 19, 2026 14:39
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

Successfully merging this pull request may close these issues.

2 participants