mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-10-04 11:14:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
django-components/docs/examples
History
Juro Oravec 9afc89ead1
docs: add Form and Tabs examples (#1411)
2025-09-29 15:58:47 +02:00
..
images docs: add Form and Tabs examples (#1411) 2025-09-29 15:58:47 +02:00
.nav.yml docs: add Form and Tabs examples (#1411) 2025-09-29 15:58:47 +02:00
form.md docs: add Form and Tabs examples (#1411) 2025-09-29 15:58:47 +02:00
index.md docs: add Form and Tabs examples (#1411) 2025-09-29 15:58:47 +02:00
README.md docs: add Form and Tabs examples (#1411) 2025-09-29 15:58:47 +02:00
tabs.md docs: add Form and Tabs examples (#1411) 2025-09-29 15:58:47 +02:00

README.md

Adding examples

Rule of thumb:

If the example is a 3rd party package or it lives under a different URL, only link to it in overview.md.

If the example is file(s) that we wrote:

  1. Define the component in sampleproject/examples/components/<component_name>/<component_name>.py.
  2. Define a view / page component in sampleproject/examples/pages/<component_name>/<component_name>.py.
  3. Add a new page here in the documentation named <component_name>.md, similarly to Tabs.
  4. Link to that new page from index.md.
  5. Update .nav.yml if needed.
  6. Add a corresponding test file in tests/test_example_<component_name>.py.