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

Docs: Broken links about defaultConfig.js #3703

Closed
YDX-2147483647 opened this issue Oct 20, 2022 · 2 comments
Closed

Docs: Broken links about defaultConfig.js #3703

YDX-2147483647 opened this issue Oct 20, 2022 · 2 comments
Labels
Area: Documentation Type: Bug / Error Something isn't working or is incorrect

Comments

@YDX-2147483647
Copy link

Years passed. src/defaultConfig.js becomes packages/mermaid/src/defaultConfig.ts, but the doc doesn't.

Problem

There are 3 links from Directives to the old defaultConfig.js.

  1. The note in Types of Directives options.

**NOTE:** These options listed here are not all the configuration options. To get hold of all the configuration options, please refer to the [defaultConfig.js](https://github.com/mermaid-js/mermaid/blob/develop/src/defaultConfig.js) in the source code.

  1. Changing flowchart config via directive, after the <ul>.

For complete list of flowchart configurations, see [defaultConfig.js](https://github.com/mermaid-js/mermaid/blob/develop/src/defaultConfig.js) in the source code.

  1. Changing Sequence diagram config via directive, after the <ul>.

For complete list of sequence diagram configurations, see _defaultConfig.js_ in the source code.

Possible Solution

  • defaultConfig.jsdefaultConfig.ts

  • https://github.com/mermaid-js/mermaid/blob/develop/src/defaultConfig.jshttps://github.com/mermaid-js/mermaid/blob/develop/packages/mermaid/src/defaultConfig.ts


I think I can make a PR … However, I guess there might be a better way (some macro?) to fix it.

(Sorry I am new to docsify. I've searched their doc but I still have no idea.)

@YDX-2147483647 YDX-2147483647 added Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect labels Oct 20, 2022
@callmetushar123
Copy link

Assign me, I will do it

@aloisklink aloisklink added Area: Documentation and removed Status: Triage Needs to be verified, categorized, etc labels Nov 18, 2022
@aloisklink
Copy link
Member

Fixed by #3738

Thanks for reporting this issue :)

We now have a GitHub Action that automatically checks for broken links, so we should hopefully avoid future errors like this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

No branches or pull requests

3 participants