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

Changes made in README of the Website #275

Closed
wants to merge 7 commits into from
Closed

Changes made in README of the Website #275

wants to merge 7 commits into from

Conversation

sathvik-ng-07
Copy link

I have submitted a pull request that addresses the documentation improvements for Drifty as discussed in the issue #273

Changes Proposed:

  • Created separate Markdown files for each documentation section (Quickstart, Getting Started, Contributing, FAQ, and Troubleshooting).
  • Populated these files with clear and detailed content, including examples and code snippets where necessary.
  • Updated the main README file to link to the newly created documentation files.
    Thank you for your time and consideration. I look forward to your feedback and the opportunity to improve the documentation for Drifty.

@vercel
Copy link

vercel bot commented Sep 24, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
drifty ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 24, 2023 6:25am

@github-actions github-actions bot added the documentation 📝 Issues/Pull Requests regarding documentation label Sep 24, 2023
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Yeah! You did it 🎉 Now, Relax 😉, Grab a drink ☕, and wait for the maintainers to check your contributions. Meanwhile, you can discuss on other issues and solve them 😀. Thank You 😃!

Meanwhile you can also discuss about the project in our Discord Server 😀

@SaptarshiSarkar12
Copy link
Owner

@sathvik-ng-07 You need to make changes in the Website. A docs section should be made in the Website which will have the subsections as said. You are not supposed to add more README files.

@SaptarshiSarkar12
Copy link
Owner

You can see this docs on how to make the website render markdown contents

@sathvik-ng-07
Copy link
Author

@sathvik-ng-07 You need to make changes in the Website. A docs section should be made in the Website which will have the subsections as said. You are not supposed to add more README files.
oh alright. seems like i misunderstood the issue. will check it out

@SaptarshiSarkar12
Copy link
Owner

It's okay, no problem. You can make the changes to the website via this PR (if you wish, there is no need to create another PR).

@SaptarshiSarkar12 SaptarshiSarkar12 linked an issue Sep 24, 2023 that may be closed by this pull request
@SaptarshiSarkar12 SaptarshiSarkar12 marked this pull request as draft September 24, 2023 06:59
@SaptarshiSarkar12 SaptarshiSarkar12 added the invalid This doesn't seem right label Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📝 Issues/Pull Requests regarding documentation invalid This doesn't seem right
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Add docs for the Website
2 participants