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: Remove documentation duplicated on the website #681

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ollypom
Copy link
Contributor

@ollypom ollypom commented Nov 2, 2023

Issue #, if available:

Description of changes:
To simplify the readme and prevent duplication I have removed the installation, getting started and config reference documentation as all parts are now covered on the finch website (runfinch.com).

I have also removed the SOCI and Snapshotter documentation pages as they are also covered in depth in the documentation (docs)

Testing done:

  • I've reviewed the guidance in CONTRIBUTING.md

License Acceptance

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@ollypom ollypom requested a review from pendo324 November 2, 2023 10:39
README.md Outdated Show resolved Hide resolved
docs/snapshotters.md Outdated Show resolved Hide resolved
Copy link
Contributor

@weikequ weikequ left a comment

Choose a reason for hiding this comment

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

Can you also help fix the mdlint error (change the * to - for lists on lines 45-50)? Thanks!

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