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 overview documentation #105

Merged

Conversation

lawrenceadams
Copy link
Collaborator

This pull request includes a significant addition to the docs/overview.md file, providing an overview of the dbt-synthea project. The changes introduce a detailed description of the project, its structure, and useful resources for further exploration.

Documentation improvements:

  • docs/overview.md: Added a comprehensive overview of the dbt-synthea project, including sections on project structure, exploring the project, and additional resources. Included a project logo for visual enhancement.

@lawrenceadams
Copy link
Collaborator Author

Open to any other ideas @katy-sadowski ! Unsure how much detail to shove in as it then is a repeat of the README.md

@lawrenceadams lawrenceadams added the documentation Improvements or additions to documentation label Nov 27, 2024
Copy link
Collaborator

@katy-sadowski katy-sadowski left a comment

Choose a reason for hiding this comment

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

it looks great! yay! thank you! just a few minor suggestions.

docs/overview.md Outdated Show resolved Hide resolved
docs/overview.md Outdated Show resolved Hide resolved
docs/overview.md Outdated Show resolved Hide resolved
docs/overview.md Show resolved Hide resolved
- [Installation](https://github.com/OHDSI/dbt-synthea?tab=readme-ov-file#developer-setup)
- [Project Abstract](https://www.ohdsi.org/wp-content/uploads/2024/10/124-Sadowski-dbt-synthea-Abstract-Julien-Nakache.pdf)

![OMOP Logo](assets/OHDSI-logo-with-text-horizontal-colored-white-background.png)
Copy link
Collaborator

Choose a reason for hiding this comment

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

do you know if it's possible to replace the dbt logo in the upper left with this instead?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

it is with a work around 😉

image

look good?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Implemented with this

docs/overview.md Outdated Show resolved Hide resolved
@lawrenceadams
Copy link
Collaborator Author

lawrenceadams commented Nov 29, 2024

Thank you @katy-sadowski ! Sorry for the repeated corrections!... Now to see if it works for real Success!

@lawrenceadams lawrenceadams merged commit 2ea5a6d into main Nov 29, 2024
@lawrenceadams lawrenceadams deleted the 86-docs-improve-customise-default-overview-page-of-dbt-docs branch November 29, 2024 19:56
@katy-sadowski
Copy link
Collaborator

wohooooo it works and the logo looks great! thank you!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: improve / customise default overview page of dbt docs
2 participants