Skip to content

Documentation Out of Sync with Latest GitHub Repository Structure #107

@ayyush1738

Description

@ayyush1738

Hi team,

First of all, thanks for the great work — the documentation is quite helpful overall. However, I noticed a few inconsistencies between the documentation and the current state of the GitHub repository that could cause confusion for new developers:

Outdated package.json References:
The documentation refers to @JuliaOS npm packages, but in the latest repo, these have been split into separate submodules. This mismatch may mislead users during setup.

Backend Server Setup Instructions:
The steps provided in the documentation for running the backend server after installation do not match the instructions in the GitHub README. It would be helpful if these could be aligned or clarified.

Would appreciate it if the docs could be updated to reflect the latest repo structure and usage instructions. Happy to open a PR if needed!

Thanks again for your work.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions