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: Add navigation structure and remove redundant topics #2203

Merged
merged 3 commits into from
Aug 16, 2024

Conversation

vnikolova
Copy link
Collaborator

Description

The changes introduced in this PR improve the navigation and structure of the Docs by doing the following:

  1. Splitting the Database and Datasource topic:

The single topic Database and Datasource has been separated into two distinct topics: Working with Databases and Working with Datasources.

These topics previously existed but were not included in the Table of Contents (TOC). I have updated them with relevant content migrated from the original Database and Datasource section. Please review to ensure that all transferred information is accurate and complete.

  1. Replacing the Samples topic with an external link
  2. Using the show-structure element to display sub-sections in the right-side navigation for each topic
  3. Consistent formatting
  • Removed 'Overview' chapter headings
  • Adjusted heading and note formatting

Type of Change

  • Documentation update

Checklist

  • Unit tests are in place
  • The build is green (including the Detekt check)
  • All public methods affected by my PR has up to date API docs
  • Documentation for my change is up to date

@vnikolova vnikolova requested a review from bog-walk August 15, 2024 15:08
@bog-walk
Copy link
Member

@vnikolova Looks good, just a couple comments about links I noticed.

@vnikolova vnikolova self-assigned this Aug 16, 2024
@vnikolova vnikolova merged commit bd886f0 into main Aug 16, 2024
5 checks passed
@vnikolova vnikolova deleted the vnikolova/docs-toc-improvements branch August 16, 2024 08:46
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