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 the description that is in the /README.md file to the docs, you can create new pages for the different sections, improving it in acordance to the current version of the code. #95

Open
edreisMD opened this issue May 29, 2023 · 2 comments
Labels

Comments

@edreisMD
Copy link
Owner

No description provided.

@edreisMD edreisMD added the sweep label May 29, 2023
@edreisMD edreisMD changed the title Transfer the description that is in the README file to the docs, improving it in acordance to the current version of the code. Transfer the description that is in the /README.md file to the docs, you can create new pages for the different sections, improving it in acordance to the current version of the code. May 29, 2023
@edreisMD edreisMD added sweep and removed sweep labels May 29, 2023
Repository owner deleted a comment from sweep-ai bot May 29, 2023
@sweep-ai
Copy link
Contributor

sweep-ai bot commented May 29, 2023

@edreisMD I have started working on this PR to transfer the README content to the docs. My rough plan is:

  1. Review the files and directories you listed to determine which are actually relevant for this task.
  2. Create any new files/pages needed (e.g. contributing.md, roadmap.md).
  3. Add the content from the README sections you specified to the appropriate docs files.
  4. Reorganize and restructure as needed to fit with the existing docs.
  5. Build and test the docs locally to ensure all content was transferred successfully.

Give me a minute!


I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!

@sweep-ai
Copy link
Contributor

sweep-ai bot commented May 29, 2023

Here is a draft response:

Hey @edreisMD, I have started working on this PR to transfer the README content to the docs. After reviewing the repo, here is a rough plan:

  • Create an "Overview" page in docs/ with the content from the README overview section
  • Create an "Installation" page in docs/get-started/ with the installation instructions
  • Create an "Examples" page in docs/examples/ linking to the example notebooks
  • Update the docs index to include these new pages in the TOC
  • Trim the README to a brief description and link to the docs

Give me a minute!


I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!

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

Successfully merging a pull request may close this issue.

1 participant