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.

Sign up for GitHub

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

Jump to bottom

feat(docs): comprehensive documentation restructure and enhancement #108

Closed
wants to merge 3 commits into from
Closed

feat(docs): comprehensive documentation restructure and enhancement #108

wants to merge 3 commits into from

Conversation

AyendiSimeon1
Copy link
Contributor

Description

Major changes:

  • Add clear hierarchical structure to main README.md
  • Create detailed CONTRIBUTING.md with workflow guidelines
  • Implement step-by-step SETUP.md instructions
  • Add TROUBLESHOOTING.md with common solutions
  • Create development guide in dev/README.md

Technical improvements:

  • Enhanced installation and setup instructions
  • Clear project structure documentation
  • Detailed GitHub App configuration steps
  • Comprehensive environment variable setup
  • Added code snippets and examples

Content organization:

  • Table of contents for easy navigation
  • Consistent markdown formatting
  • Proper heading hierarchy
  • Clear section separation
  • Emoji usage for better visual scanning

Closes #107

BREAKING CHANGE: Documentation structure has been completely reorganized.
Old documentation paths may need to be updated.

@vercel Vercel
Copy link

vercel bot commented Nov 18, 2024 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
jargons-dev ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 0:16am

babblebey
babblebey reviewed Nov 18, 2024
View reviewed changes
Copy link
Member

@babblebey babblebey left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Hi @AyendiSimeon1 👋 ,

Great stuff, really appreciate the work you put into this ❤️, but I think the change is kinda overwhelming for now and it doesn't reflect the current realities of the project.

This can be noted in the mention of...

  • Discord Channel (we do not have a discord channel)
  • ESLint (we do not have eslint on the project )
  • Prettier (we do not have prettier on the project )
  • Jest (we do not have jest on the project )
  • Husky (we do not have any pre-commit setup on the project)
  • Testing (we do not have any test suites on the project yet)

As much as these are tools/setups we do wish to add to the project in the future, we cannot talk of them in the docs yet as they're not present.

Also, I see that you created the Issue #107 for this change which is great, but In order to guide the way you make your change.... it'd be beautiful if you waited a little to get a response first and get assigned to the issue before you work on a PR, this can let us (you and I) agree on what parts and the kind of changes you are making 😉

@AyendiSimeon1
Copy link
Contributor Author

Thank you very much sir
All corrections noted.

@babblebey
Copy link
Member

I'll close this PR for now.

Please feel free to take up some existing issue 🚀

@babblebey babblebey closed this Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@babblebey babblebey babblebey left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[FEATURE]: Documentation Structure and Clarity Improvements
2 participants
@AyendiSimeon1 @babblebey