mirror of
https://github.com/strapi/strapi.git
synced 2025-08-29 19:22:24 +00:00

* fix: make contrib docs landing message clearer to users * v5.1.1 to main (#21954) * enhancement: ui issues and french translations (#21633) * chore: ui issues and french translations * chore: added missing translation * chore: made it prettier * fix: test CI/CD building repo 2 times (#21740) * fix: do not display fill from locales if i18n no enabled (#21737) * fix: do not display fill from locales if i18n no enabled * chore: disable only if there is not i18n enabled * fix: send ids when connecting relations to update u&p user role (#21726) * fix:update role * fix: send entry id when connecting/disconnecting relations * fix: changed empty components wording (#21630) * fix: changed empty components wording * fix: updated selectors * fix: made it prettier * enhancement: add preview panel button (#21776) * chore: add test workflow filters for each test type (#21770) * chore: upgrade mysql2 package to 3.9.8 (#21795) * feat: add mapping property support for documentation plugin's open api generated docs (#21752) * feat: add mapping property support for documentation plugin's open API generated spec Dynamic zones are reflected in the OpenAPI docs generated as an anyOf. We can use a discriminator and mapping to improve the docs. * fix: missing one value enum for __component property * enhancement: extract logic to convert component names to OpenAPI names * chore: run prettier write on clean schema attributes --------- Co-authored-by: Jamie Howard <48524071+jhoward1994@users.noreply.github.com> * chore: fix mysql workflow (#21801) * chore: upgrade koa/router to 12.0.2 (#21802) * Update "upgrade major" rules (#21745) * fix: broken list view pagination (#21800) * fix: broken list view pagination * chore: add list view pagination e2e test * enhancement: add copy preview url button (#21780) * enhancement: add copy preview button * chore: remove useClipboard from upload plugin * Add <latest> Upgrade Command (#21754) * Make locale/localizations private for non-localized cts (#21495) * chore: upgrade sendgrid-mail to 8.1.3 (#21797) * chore: re-enable history e2e tests (#21739) * fix: reenable history api tests fix: flaky findAndClose fix: close notifications * chore: add test workflow filters for each test type * chore: fix node versions * fix: match format of test.yml * revert: don't add test_result to skipped_tests * fix: add new outputs vars --------- Co-authored-by: Ben Irvin <ben@innerdvations.com> * fix: search by numeric numbers in a relation (#21873) * Sort Generated Content-Types and Components Definitions (#21868) * fix(e2e): remove webkit skip conditions (#21611) * fix(e2e): remove webkit skip conditions * chore: revert uniqueness spec to test others on ci * fix(e2e): ctb navigation * chore: ci config to speed up testing * chore: revert lock * chore(e2e): wip add webkit waiting * chore: single out history spec changes for ci * chore(e2e): use new webkit navigation for all affected test files * chore(e2e): revert e2e ci config so all tests run again * chore(e2e): temp skip uniqueness to test others * chore(e2e): revert so all tests run again * chore(e2e): re-skip uniqueness in webkit * chore(e2e): revert workflow yaml * chore(e2e): pr feedback --------- Co-authored-by: Ben Irvin <ben.irvin@strapi.io> * fix(strapi/types): add Attribute column type (#21858) * chore: add preview tracking (#21913) * chore: upgrade plop to 4.0.1 (#21798) * chore: upgrade cookie to 0.7.1 (#21833) * enhancement: DTS assert count of items sent and received is equal (#21900) * feat: added a count, start, finish counts to compare data recieved with data sent * feat: refactoring * feat: refactoring * v5.1.1 --------- Co-authored-by: Lucas Boilly <45385696+lucasboilly@users.noreply.github.com> Co-authored-by: Boegie19 <34578426+Boegie19@users.noreply.github.com> Co-authored-by: Rémi de Juvigny <8087692+remidej@users.noreply.github.com> Co-authored-by: Ben Irvin <ben.irvin@strapi.io> Co-authored-by: Pedro Cerejo <pedro.cerejo@tecnico.ulisboa.pt> Co-authored-by: Jamie Howard <48524071+jhoward1994@users.noreply.github.com> Co-authored-by: Jean-Sébastien Herbaux <jean-sebastien.herbaux@epitech.eu> Co-authored-by: Rémi de Juvigny <remi.dejuvigny@strapi.io> Co-authored-by: Ben Irvin <ben@innerdvations.com> Co-authored-by: Andrei Luca <1881266+iamandrewluca@users.noreply.github.com> Co-authored-by: Bassel Kanso <basselkanso82@gmail.com> * fix: prettier --------- Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com> Co-authored-by: Alexandre BODIN <alexandrebodin@users.noreply.github.com> Co-authored-by: Lucas Boilly <45385696+lucasboilly@users.noreply.github.com> Co-authored-by: Boegie19 <34578426+Boegie19@users.noreply.github.com> Co-authored-by: Rémi de Juvigny <8087692+remidej@users.noreply.github.com> Co-authored-by: Ben Irvin <ben.irvin@strapi.io> Co-authored-by: Pedro Cerejo <pedro.cerejo@tecnico.ulisboa.pt> Co-authored-by: Jamie Howard <48524071+jhoward1994@users.noreply.github.com> Co-authored-by: Jean-Sébastien Herbaux <jean-sebastien.herbaux@epitech.eu> Co-authored-by: Rémi de Juvigny <remi.dejuvigny@strapi.io> Co-authored-by: Ben Irvin <ben@innerdvations.com> Co-authored-by: Andrei Luca <1881266+iamandrewluca@users.noreply.github.com> Co-authored-by: Bassel Kanso <basselkanso82@gmail.com>
46 lines
2.5 KiB
Markdown
46 lines
2.5 KiB
Markdown
---
|
||
sidebar_position: 1
|
||
sidebar_label: Introduction
|
||
---
|
||
|
||
# Strapi contributor documentation
|
||
|
||
Welcome to the Strapi Contributor documentation.
|
||
|
||
:::caution
|
||
No single Strapi squad “owns” the contributor documentation, it's a collective effort.
|
||
:::
|
||
|
||
This documentation site is a constant WIP so please, continue to add and improve these docs. These are not “user-facing” docs,
|
||
they're related directly to the codebase for both internal and external engineers written with that in mind they explain
|
||
technical concepts but also hold documentation for hooks, utils etc.
|
||
|
||
If you don’t plan to make any contributions to [strapi/strapi](https://github.com/strapi/strapi), you probably shouldn’t read and use the present documentation, and [docs.strapi.io](https://docs.strapi.io) might be a better fit for your use case.
|
||
|
||
## Structure
|
||
|
||
The general layout focusses on 4 key areas:
|
||
|
||
### Guides
|
||
|
||
This is where you'll probably want to start off. We have our contributing guides & code of conduct which are very important to read. There are also useful guides on common situations whilst developing such as ["Working with the Design System"](/guides/working-with-the-design-system) and higher-level guides such as best practices for frontend development (coming soon).
|
||
|
||
### Docs
|
||
|
||
Within the docs section we have a multitude of both technical and conceptual documentation diving deep into particular parts of the Strapi monorepo that may not make as much sense as just reading the code, like ["Relations reordering in the database"](/docs/core/database/relations/reordering). There's also usage documentation for various pieces of code such as the [useDragAndDrop](/docs/core/content-manager/hooks/use-drag-and-drop) hook.
|
||
|
||
### API Reference
|
||
|
||
An advanced deep dive into some of the core driving classes of Strapi with explanations on the methods & parameters available on commonly exposed classes as well as examples to compliment them for easier understanding.
|
||
|
||
### RFCs
|
||
|
||
A growing section we intend to populate over time with public-facing RFCs once approved to maintain as a record. These assist in understanding the design direction of features and code to understand the contextual "whys" that may not be apparent.
|
||
|
||
## When should you add content?
|
||
|
||
Content should be added typically when you add any new feature – especially enterprise e.g.
|
||
`Review Workflows` and also when you add new code other engineers may find another use for e.g. a
|
||
new hook. There's no guidelines on what to add vs what not to add, as defined above we add a variety
|
||
of material to help onboard contributers.
|