Readme Updates

[Aniket1026]

In the contribution guidelines documentation . As for some beginners can we add some more steps that may help them setting the project locally on their system ? I'm attaching a screenshort regarding adding some documentation updates.

If it looks helping you can assign me . So i can raise a PR

Also in the contributing.md it is stated that Documentation source files are in /src/docs directory . I'm just not able to find that directory too . My doubt here is did the directory name needs to update or am i making a mistake regarding the path directory.

[sidharthv96]

/src/docs directory has moved to packages/mermaid/src/docs.

[Aniket1026]

Created the PR for the Steps i added.

But what for the updated path ? Should i also change the path in the documentation from /src/docs to packages/mermaid/src/docs ?

[sidharthv96]

You can update the path

[Aniket1026]

@sidharthv96 can I raise another issue for automating the linting as you mentioned earlier?

[weedySeaDragon]

@Aniket1026 - I just submitted PR #3814 that revises the instructions for contributing/developing.
Can you please review it? I'd love your feedback.

Hopefully I can incorporate your feedback and address your issue with it.

[Aniket1026]

@weedySeaDragon I apologize for replying so late as I was just busy in other things . And for the review you asked for it's upto maintainers what they want in the project but personally i liked how you described your changes while raising the issue.
keep it up and contribute to open source projects 😄 .

[jgreywolf]

Closing this issue as it should be addressed when PR #3814 is merged