Skip to content

Various docs improvements #331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 2, 2017
Merged

Various docs improvements #331

merged 2 commits into from
Nov 2, 2017

Conversation

dunglas
Copy link
Member

@dunglas dunglas commented Nov 2, 2017

  • Rethink the TOC
  • Advise best practices (do not use FOSUser nor NelmioApiDoc)
  • Update the index of Core
  • Remove some out of sync parts (especially regarding ids)
  • Add some more use cases (e.g.: to many relations)
  • Ensure snippets consistency

index.md Outdated
@@ -86,23 +95,16 @@
2. [Registering the Service](core/operation-path-naming.md#registering-the-service)
3. [Configure it](core/operation-path-naming.md#configure-it)
19. [Accept `application/x-www-form-urlencoded` Form Data](core/form-data.md)
12. [Using External Vocabularies](core/external-vocabularies.md)
Copy link
Member

Choose a reason for hiding this comment

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

20?

index.md Outdated
@@ -86,23 +95,16 @@
2. [Registering the Service](core/operation-path-naming.md#registering-the-service)
3. [Configure it](core/operation-path-naming.md#configure-it)
19. [Accept `application/x-www-form-urlencoded` Form Data](core/form-data.md)
12. [Using External Vocabularies](core/external-vocabularies.md)
13. [Extending the JSON-LD context](core/extending-jsonld-context.md)
Copy link
Member

Choose a reason for hiding this comment

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

21? etc.

@dunglas dunglas merged commit 44f76b9 into api-platform:2.1 Nov 2, 2017
@dunglas dunglas deleted the improvements branch November 2, 2017 13:31
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