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

Very Poor Demo Apps and Documentation #43

Open
niagrawal-microsoft opened this issue Sep 21, 2024 · 0 comments
Open

Very Poor Demo Apps and Documentation #43

niagrawal-microsoft opened this issue Sep 21, 2024 · 0 comments

Comments

@niagrawal-microsoft
Copy link

1) Missing .env files: There are no sample .env files provided, which makes setting up the project difficult. Even in other comments, a link to an .env file is shared, but the keys don't match what's needed for the current version of the code.

2) Broken Demo App: The demo app referenced in the documentation is not working, which adds confusion for anyone trying to test or run the application.

3) Broken Links: Many links throughout the documentation are broken, making it hard to navigate and find necessary information.

4) Poor Code Documentation: The codebase is filled with commented-out sections, but without any actual comments explaining them. This makes understanding the intent behind certain sections of code very difficult.

5) Outdated README: The README.md file is outdated. Following the provided steps does not result in the repo running successfully.

Suggestions:
It would be more beneficial if the ONDC team focuses on improving the code and documentation rather than advertising ONDC’s vision of changing eCommerce. Practicality in setup and use is crucial for developer adoption.

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

No branches or pull requests

1 participant