mermaid icon indicating copy to clipboard operation
mermaid copied to clipboard

Readme Updates

Open Aniket1026 opened this issue 2 years ago • 6 comments

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.

mermaid js readme

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.

mermaid js

Aniket1026 avatar Oct 05 '22 19:10 Aniket1026

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

sidharthv96 avatar Oct 07 '22 08:10 sidharthv96

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 ?

Aniket1026 avatar Oct 07 '22 20:10 Aniket1026

You can update the path

sidharthv96 avatar Oct 08 '22 02:10 sidharthv96

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

Aniket1026 avatar Oct 10 '22 10:10 Aniket1026

@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.

weedySeaDragon avatar Nov 18 '22 19:11 weedySeaDragon

@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 😄 .

Aniket1026 avatar Dec 11 '22 06:12 Aniket1026

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

jgreywolf avatar Apr 06 '23 14:04 jgreywolf