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

Documentation updates #22

Merged
merged 8 commits into from
Nov 4, 2022
Merged

Documentation updates #22

merged 8 commits into from
Nov 4, 2022

Conversation

lovromazgon
Copy link
Member

@lovromazgon lovromazgon commented Sep 22, 2022

This PR updates our documentation to be more up-to-date. It is not perfect, but it is hopefully better than what was there before.

Sidenote about the external link - moving "Connector List" link inside of the "Connectors" category is a pain in the a$$, because the sidebar is currently autogenerated. To do this we need to manually generate the list (which I had a hard time doing as everything was breaking left and right). There is talk about supporting an exclude option which would be perfect for us as we could exclude connectors and manually generate just that category.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 20, 2022

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 57e3a28
Status: ✅  Deploy successful!
Preview URL: https://b0fa98ec.conduit-site.pages.dev
Branch Preview URL: https://lovro-doc-updates.conduit-site.pages.dev

View logs

@lovromazgon lovromazgon marked this pull request as ready for review October 24, 2022 15:57
@lovromazgon lovromazgon requested a review from a team October 24, 2022 15:57
Copy link
Contributor

@maha-hajja maha-hajja left a comment

Choose a reason for hiding this comment

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

Nice work! we finally have some fresh docs :D
just added some nitpicks

docs/introduction/getting-started.mdx Outdated Show resolved Hide resolved
docs/introduction/getting-started.mdx Outdated Show resolved Hide resolved
docs/introduction/what-is-conduit.mdx Outdated Show resolved Hide resolved
docs/introduction/architecture.mdx Outdated Show resolved Hide resolved
docs/introduction/glossary.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@hariso hariso left a comment

Choose a reason for hiding this comment

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

Great work, Lovro!

docs/configuration/pipeline-configuration-files.mdx Outdated Show resolved Hide resolved
docs/configuration/pipeline-configuration-files.mdx Outdated Show resolved Hide resolved
docs/introduction/connectors.mdx Outdated Show resolved Hide resolved
docs/connectors/behavior.mdx Outdated Show resolved Hide resolved
docs/processors/getting-started.md Outdated Show resolved Hide resolved
docs/processors/getting-started.md Outdated Show resolved Hide resolved
Copy link
Contributor

@hariso hariso left a comment

Choose a reason for hiding this comment

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

Fantastic work Lovro!

@lovromazgon lovromazgon merged commit 3433960 into main Nov 4, 2022
@lovromazgon lovromazgon deleted the lovro/doc-updates branch April 11, 2023 13:11
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.

3 participants