Improved New Documentation #3678

emersonbottero · 2022-10-15T03:55:16Z

📑 Summary

New documentation migrating the last docs to vitepress:

move docs from mermaid/src docs to mermaid/docs
mermaid docs are still tranformed and copied to docs in the root folder
added pipeline to publish docs to github pages (usually I have to algo go to setting and then publish to github using gh-pages branch)
move package scripts related to docs from root to mermaid package
delete old script that creates setup.md for a new one docs:code (made some improvements in the jsdoc of ts files used here)
remove lint from new docs (we can enable again later but must be sure the rules are ok first)
added meet the team in the main documentation page 😁
reorganize all docs to folders following the current menu convention (it can be changed later for better organization)
removed old v-docs (temporary created to show case vitepress)

📏 Design Decisions

suggestions made in #3610 are not included

Make sure you

📖 have read the contribution guidelines
💻 have added unit/e2e tests (if appropriate)
🔖 targeted develop branch

sidharthv96 · 2022-10-17T06:04:27Z

@emersonbottero can you add details of what exactly the changes are in the PR description?

emersonbottero · 2022-10-17T16:12:14Z

@emersonbottero can you add details of what exactly the changes are in the PR description?

done!

sidharthv96

@emersonbottero This is a wonderful set of changes. Really appreciate the effort you've put into this 🚀 ❤️

move docs from mermaid/src docs to mermaid/docs

Let's keep them inside src/docs as they are the source for the docs.

mermaid docs are still tranformed and copied to docs in the root folder

Please add the note, tip, etc to the transforms.

remove lint from new docs

Can you share which rules are problematic?

packages/mermaid/docs/.vitepress/config.ts

sidharthv96 · 2022-10-17T16:28:25Z

docs/config/usage.md

-```warning
+::: warning


Keep this as ```warning (markdown syntax), you can add a transform step in docs.mts to convert to :::.

Same for rest of these.

actually vitepress need those to be ::: by default.
did you meant to turn ::: in ``` in the transform step?
then it would be better to transform in

> **Note** > This is a note > **Warning** > This is a warning

that renders as:

Note
This is a note

Warning
This is a warning

done if it is ok with you
scroll down in
https://github.com/emersonbottero/mermaid/blob/develop/docs/config/usage.md

actually vitepress need those to be ::: by default.

This is the flow I had in mind. Is this not how it's done?

flowchart src["/packages/mermaid/src/docs"] --> |Transform| docs["/docs"] --> |Vitepress| gh[GitHub pages] docs --> g[Github Repo]

Loading

Is this how it's being done now?

flowchart src["/packages/mermaid/src/docs"] --> |Transform| docs["/docs"] src--> |Vitepress| gh[GitHub pages] docs --> g[Github Repo]

Loading

I would prefer the source docs to be proper markdown and not have any vitepress specific things.

Is the second one..

if you remove the warning it is the same.. to do what you want we sould use

Warning
Any text of warning block

we can try to do that later and change both transform but it is harder then the current version.

docs/index.md

docs/intro/index.md

packages/mermaid/docs/.vitepress/config.ts

packages/mermaid/docs/syntax/flowchart.md

packages/mermaid/docs/syntax/gantt.md

packages/mermaid/package.json

sidharthv96 · 2022-10-17T17:06:52Z

Padding needs to be consistent.

Screen.Recording.2022-10-17.at.10.35.39.PM.mov

Copy code is a very useful feature. Can we also add an edit button, so the diagram opens in live editor?
Can create a separate issue for this if it's complicated.

Overlap issue in gantt.

Can you add #3610 (comment) logo ?

emersonbottero · 2022-10-17T21:59:29Z

Padding needs to be consistent.

Screen.Recording.2022-10-17.at.10.35.39.PM.mov
Copy code is a very useful feature. Can we also add an edit button, so the diagram opens in live editor? Can create a separate issue for this if it's complicated.

Overlap issue in gantt.

Can you add #3610 (comment) logo ?

I removed some css I added to make the reading container larger.. I removed those ..

Can you confirm the logo on the main page is ok as in the images I posted in #3610 (comment)?
I can remove the background color and left the default square logo.

it is possible to make the links but I would have to understand how to generate the live editor link

for the favicon it will be the default square icon as it is.

.gitignore

.lintstagedrc.json

CONTRIBUTING.md

docs/.vitepress/config.ts

docs/community/newDiagram.md

packages/mermaid/src/docs.mts

packages/mermaid/src/docs/config/usage.md

packages/mermaid/src/docs/syntax/flowchart.md

packages/mermaid/src/docs/vite.config.ts

sidharthv96 · 2022-10-18T04:26:23Z

it is possible to make the links but I would have to understand how to generate the live editor link

You can refer this and use the base64 encoder.
But let's do it after this one is merged.

…nto pr/emersonbottero/3678 * 'develop' of https://github.com/emersonbottero/mermaid: docs: fix layout problem docs: added warning and notes docs: added warning and notes docs: added warning and notes docs: small improvements

sidharthv96 · 2022-10-18T07:04:00Z

sidharthv96 · 2022-10-18T07:05:09Z

How can we make sure that we have all the recent changes in docs?

emersonbottero · 2022-10-18T22:35:00Z

didn't understood

emersonbottero · 2022-10-18T22:35:58Z

How can we make sure that we have all the recent changes in docs?

I get the last one and changed..
but I guess if something is missing we can add it later..
there are too many alterations at once in the new docs

emersonbottero · 2022-10-18T23:38:17Z

Padding needs to be consistent.

Screen.Recording.2022-10-17.at.10.35.39.PM.mov
Copy code is a very useful feature. Can we also add an edit button, so the diagram opens in live editor? Can create a separate issue for this if it's complicated.

Overlap issue in gantt.

Can you add #3610 (comment) logo ?

you where correct.. I fixed the width error (probably will also be fixed in vitepress soon)
I added the logo the same way as where in the images I sent in the mentioned link

sidharthv96 · 2022-10-19T15:19:13Z

didn't understood

Just small issue.

The lines with > should be in new lines.

Extra **

packages/mermaid/src/docs/.vitepress/mermaid-markdown-all.ts

Co-authored-by: Alois Klink <alois@aloisklink.com>

sidharthv96 · 2022-10-31T06:42:22Z

@aloisklink Something we'd also want is to point the Edit this page on GitHub link to the source-files, but that might also be a lot of work!

The current link points to https://github.com/mermaid-js/mermaid/edit/develop/packages/mermaid/src/docs/intro/index.md which should be the correct link once the PR is merged.

…3678 * origin/develop: chore(deps): update all non-major dependencies chore(deps): update all non-major dependencies chore: Update bug report template

sidharthv96 · 2022-10-31T14:20:37Z

@emersonbottero, seems like you removed the deploy action. How will it be pushed to github pages? 🤔

sidharthv96 · 2022-10-31T16:45:55Z

Deployed to https://sidharthv96.github.io/mermaid

mmorel-35 · 2022-10-31T17:06:09Z

On flowchart ans Sequence Diagram

On Class Diagram

On ER Diagram

One icon is not resloved ?

On Directives

mmorel-35 · 2022-10-31T17:10:57Z

Here are all the errors I could see from the chrome console while browsing through https://sidharthv96.github.io/mermaid

Except this errors, the website looks really great !!!

* develop: chore(docs): Update live editor links update user story link feat(gantt): Add option 'tickInterval' for custom tick interval Convert attr to classed Convert attr to style

emersonbottero added 2 commits October 15, 2022 00:50

docs: new Documentation

cbcf7f8

docs: new Documentation

0da56a1

This was referenced Oct 15, 2022

Documentation restructure and update #2910

Open

Complete vitepress migration #3597

Closed

sidharthv96 requested changes Oct 17, 2022

View reviewed changes

sidharthv96 assigned emersonbottero Oct 17, 2022

sidharthv96 mentioned this pull request Oct 17, 2022

(docs) duplicated info in Contributing.md and docs/development.md #3682

Closed

This comment was marked as outdated.

Sign in to view

emersonbottero added 5 commits October 17, 2022 19:32

docs: small improvements

c8b377b

docs: added warning and notes

c45bf05

docs: added warning and notes

d296049

docs: added warning and notes

e95eadd

docs: fix layout problem

66ea491

sidharthv96 requested changes Oct 18, 2022

View reviewed changes

sidharthv96 added 2 commits October 18, 2022 12:28

fix: Live editor links

f2571e9

emersonbottero added 2 commits October 20, 2022 00:06

docs: contribute with vitepress

4cd1e9a

docs: small fixes

4b64775

sidharthv96 reviewed Oct 20, 2022

View reviewed changes

packages/mermaid/src/docs/.vitepress/mermaid-markdown-all.ts Outdated Show resolved Hide resolved

sidharthv96 and others added 2 commits October 31, 2022 12:01

chore: Ignore packages/mermaid/src/docs/config/setup

d1e235a

Update packages/mermaid/.lintstagedrc.json

450c308

Co-authored-by: Alois Klink <alois@aloisklink.com>

Merge remote-tracking branch 'origin/develop' into pr/emersonbottero/…

24198ed

…3678 * origin/develop: chore(deps): update all non-major dependencies chore(deps): update all non-major dependencies chore: Update bug report template

sidharthv96 added 12 commits October 31, 2022 19:51

Precommit Test

359a570

Precommit Test

d08701e

Precommit Test

1e410de

Precommit Test

3b7463e

chore: Cleanup lintStaged

c72bdc8

chore: Add actions deploy

f36e0ef

Publish

56c2fe3

Fix lint

2c5a207

Add pnpm

78565d1

Fix base

83fb0f4

chore: Remove test branch

b735c21

chore: Configure typedoc source links

a923478

fix: Lint

61b7033

sidharthv96 mentioned this pull request Oct 31, 2022

docs: Update references to default config in directives page #3738

Merged

3 tasks

sidharthv96 added 4 commits November 1, 2022 10:34

docs: Change yarn to pnpm

70ec91d

Update contributors

4699ba3

Merge branch 'develop' into pr/emersonbottero/3678

86f835c

* develop: chore(docs): Update live editor links update user story link feat(gantt): Add option 'tickInterval' for custom tick interval Convert attr to classed Convert attr to style

chore: cSpell

05fd856

sidharthv96 merged commit 549c2b8 into mermaid-js:develop Nov 2, 2022

sidharthv96 mentioned this pull request Nov 2, 2022

Errors in new documentation #3744

Open

aloisklink mentioned this pull request Nov 8, 2022

Add GHA that will check links + Fix broken links #3765

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improved New Documentation #3678

Improved New Documentation #3678

emersonbottero commented Oct 15, 2022 •

edited

Loading

sidharthv96 commented Oct 17, 2022

emersonbottero commented Oct 17, 2022

sidharthv96 left a comment

sidharthv96 Oct 17, 2022

sidharthv96 Oct 17, 2022

emersonbottero Oct 17, 2022

emersonbottero Oct 18, 2022 •

edited

Loading

sidharthv96 Oct 18, 2022

emersonbottero Oct 18, 2022

sidharthv96 commented Oct 17, 2022 •

edited

Loading

emersonbottero commented Oct 17, 2022 •

edited

Loading

This comment was marked as outdated.

sidharthv96 commented Oct 18, 2022

sidharthv96 commented Oct 18, 2022

sidharthv96 commented Oct 18, 2022

emersonbottero commented Oct 18, 2022

emersonbottero commented Oct 18, 2022

emersonbottero commented Oct 18, 2022

sidharthv96 commented Oct 19, 2022

sidharthv96 commented Oct 31, 2022

sidharthv96 commented Oct 31, 2022

sidharthv96 commented Oct 31, 2022

mmorel-35 commented Oct 31, 2022 •

edited

Loading

mmorel-35 commented Oct 31, 2022 •

edited

Loading

Improved New Documentation #3678

Improved New Documentation #3678

Conversation

emersonbottero commented Oct 15, 2022 • edited Loading

📑 Summary

📏 Design Decisions

sidharthv96 commented Oct 17, 2022

emersonbottero commented Oct 17, 2022

sidharthv96 left a comment

Choose a reason for hiding this comment

sidharthv96 Oct 17, 2022

Choose a reason for hiding this comment

sidharthv96 Oct 17, 2022

Choose a reason for hiding this comment

emersonbottero Oct 17, 2022

Choose a reason for hiding this comment

emersonbottero Oct 18, 2022 • edited Loading

Choose a reason for hiding this comment

sidharthv96 Oct 18, 2022

Choose a reason for hiding this comment

emersonbottero Oct 18, 2022

Choose a reason for hiding this comment

sidharthv96 commented Oct 17, 2022 • edited Loading

emersonbottero commented Oct 17, 2022 • edited Loading

This comment was marked as outdated.

sidharthv96 commented Oct 18, 2022

sidharthv96 commented Oct 18, 2022

sidharthv96 commented Oct 18, 2022

emersonbottero commented Oct 18, 2022

emersonbottero commented Oct 18, 2022

emersonbottero commented Oct 18, 2022

sidharthv96 commented Oct 19, 2022

sidharthv96 commented Oct 31, 2022

sidharthv96 commented Oct 31, 2022

sidharthv96 commented Oct 31, 2022

mmorel-35 commented Oct 31, 2022 • edited Loading

mmorel-35 commented Oct 31, 2022 • edited Loading

emersonbottero commented Oct 15, 2022 •

edited

Loading

emersonbottero Oct 18, 2022 •

edited

Loading

sidharthv96 commented Oct 17, 2022 •

edited

Loading

emersonbottero commented Oct 17, 2022 •

edited

Loading

mmorel-35 commented Oct 31, 2022 •

edited

Loading

mmorel-35 commented Oct 31, 2022 •

edited

Loading