Skip to content
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

docs: EXPOSED-600 Add links to API docs for functions and classes #2339

Merged
merged 7 commits into from
Dec 19, 2024

Conversation

vnikolova
Copy link
Collaborator

Description

Add links to the API docs for functions and classes and fix their formatting where necessary.

Details

This PR focuses on the topics covered within the following sections:

  • Databases
  • Schemas
  • Deep dive into DSL
  • Deep dive into DAO

And applies the following changes:

  1. Add a link to the API docs on the first mention of an Exposed function, class, or interface.
  2. Format functions per the Ktor Style Guide.
  3. Use descriptive titles instead of function names where appropriate. (mainly in the 'CRUD operations' topics)

Preview on staging

Type of Change

  • Documentation update

Related Issues

EXPOSED-600 Add links to the API Documentation for functions and classes

@vnikolova vnikolova requested a review from bog-walk December 18, 2024 15:09
@vnikolova
Copy link
Collaborator Author

Thanks for the comments @bog-walk 🙏 Fixed!

@vnikolova vnikolova merged commit 8db5269 into main Dec 19, 2024
5 checks passed
@vnikolova vnikolova deleted the vnikolova/EXPOSED-600 branch December 19, 2024 14:53
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