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

hard to understand links (everything is called "documentation") #61

Open
jonenst opened this issue Apr 11, 2019 · 0 comments
Open

hard to understand links (everything is called "documentation") #61

jonenst opened this issue Apr 11, 2019 · 0 comments

Comments

@jonenst
Copy link
Contributor

jonenst commented Apr 11, 2019

  • Do you want to request a feature or report a bug?
    bug

  • What is the current behavior?
    it's hard to know where a link will take you to. When browsing the docs, you decide depending on the link if you want to visit it or not. Since all links are named "documentation", you have to hover your mouse on it to know where it goes. On mobile it's even worse..

  • If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem
    https://www.powsybl.org/docs/ has 3 links with the text "documentation". There are more of them in other pages:

./docs/index.md:Read this [documentation](configuration/modules/index.md)
./docs/index.md:Read this [documentation](tools/index.md)
./docs/index.md:Read this [documentation](tutorials/index.md)
./docs/loadflow/security-analysis.md:Read this [documentation](../contingencies/index.md)
./docs/loadflow/security-analysis.md:Read this [documentation](../configuration/parameters/SecurityAnalysisParameters.md)
./docs/configuration/modules/mapdb-app-file-system.md:Read the [documentation](../../afs/afs-mapdb.md)
./docs/configuration/modules/local-app-file-system.md:Read the [documentation](../../afs/afs-local.md)
./docs/configuration/modules/groovy-dsl-contingencies.md:Read the [documentation](../../contingencies/GroovyDslContingenciesProvider.md)
./docs/tools/loadflow-validation.md:Read this [documentation](http://rte-france.github.io/hades2/index.html)
./docs/tools/action-simulator.md:Read this [documentation](http://rte-france.github.io/hades2/index.html)
./docs/tools/run-impact-analysis.md:read this [documentation](../contingencies/index.md)
./docs/tools/loadflow.md:Read this [documentation](http://rte-france.github.io/hades2/index.html)
./docs/tools/afs.md:Read the [documentation]()
./docs/tools/sensitivity-computation.md:read this [documentation](../sensitivity/index.md)
./docs/tools/security-analysis.md:read this [documentation](../contingencies/index.md)
./docs/tools/security-analysis.md:Read this [documentation](../loadflow/security-analysis.md)
./docs/tools/security-analysis.md:Read this [documentation](http://rte-france.github.io/hades2/index.html)
  • What is the expected behavior?
    You should be able to get a basic understanding of where a link takes you to just by looking at it, not having to read a full paragraph of text around it.

  • What is the motivation / use case for changing the behavior?
    Make a better documentation

@miovd miovd mentioned this issue Jan 30, 2020
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant