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

Transfer README content to docs #96

Closed
wants to merge 2 commits into from

Conversation

sweep-ai[bot]
Copy link
Contributor

@sweep-ai sweep-ai bot commented May 29, 2023

This PR transfers the content from the README file to the docs folder, reorganizing the sections and improving the descriptions.

The main changes are:

  • Move the sections "Installation", "Usage" and "Examples" to the docs/get-started/quickstart.md file.
  • Improve the descriptions on the docs/index.rst file.
  • Remove the duplicated content from the README, keeping only a brief description and links to the docs.

This will help to have a cleaner documentation, with installation and usage instructions on the docs, and the README acting as a summary.

Fixes #95.

@edreisMD edreisMD closed this May 29, 2023
@edreisMD edreisMD deleted the sweep/transfer-readme-to-docs branch May 29, 2023 04:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant