[andrew-demb]

Closes #228. Related to thecodingmachine/graphqlite#376.

The Symfony bundle documentation currently lives in the GraphQLite core docs. It is out of date: it still covers Symfony 4/5, AppKernel and the routes.xml import, and it doesn't mention schema.auto_reload or graphqlite:dump-schema. This PR moves the bundle docs into this repository, so that they live next to the code and core can link to them.

What's included

• Documentation in docs/, written in RST so it can be published on symfony.com/bundles:

  • installation
  • a getting-started tutorial
  • configuration reference
  • security (#[Logged]/#[Right]/#[Security], login/logout/me, query limits)
  • the request and GraphQL context
  • file uploads
  • validation
  • GraphiQL
  • extending (service tags)
  • cache and performance
  • console commands
  • troubleshooting

  Generic GraphQLite topics link to the core documentation instead of repeating it.

• .symfony.bundle.yaml, so symfony.com can build the docs once the bundle is listed.

• Tested examples:

  • The tutorial and security code blocks are copies of real classes in tests/DocsFixtures/.
  • DocsExamplesTest runs the documented queries and mutations against them.
  • It also fails if a code block in the docs drifts from its fixture.

• DOCtor-RST lint in CI (.github/workflows/docs.yaml).

• README cut down to a pitch, the requirements, a quick start, and a link to the docs.

• Smaller fixes:

  • The branch-alias in composer.json said 6.0.x-dev; it now says 7.x-dev.
  • The link in the configuration info() and in config-template/ now points to the new docs.

Reviewing

The docs render on GitHub: start at docs/index.rst (from fork). Links between pages (:doc:) show as plain text on GitHub; they will work on symfony.com.

Follow-ups (not in this PR)

• Ask the Symfony docs team to list the bundle on symfony.com/bundles, then point the README to the symfony.com URL (ref: How can a community bundle get its docs listed on symfony.com/bundles? symfony/symfony-docs#23442).
• Update the core docs (graphqlite#376) to link here.
• Update the post-install message of the Flex recipe in symfony/recipes-contrib; it still links to the old core docs page.
• LoginController always creates its token for the main firewall. security.firewall_name is only used for the session key and to find the user provider. This looks like a bug to fix separately.

[andrew-demb]

Also, I would like to disable the wiki after merging this.

Refs: #204