Developer documentation link inside readme is not working

[DIWAKARKASHYAP]

Developer documentation link inside readme is not working

[DIWAKARKASHYAP]

i want to setup this repo in my local system ,
also can you provide me the correct link so i can raise the PR

[ErikMichelson]

We have a broken link checker for the website repository. Maybe it would be good to integrate a broken-link-checker for markdown files/docs too.

Nevertheless, currently the 2.0 docs are here: https://docs.hedgedoc.dev/how-to/develop/setup/
However, this and other things regarding the 2.0 alpha might change in the future anyways.

[DIWAKARKASHYAP]

@ErikMichelson whaen i install turbo package then it shows

[mrdrogdrog]

There is no need to execute this command. Turbo is already part of the dependencies and will be installed if you execute yarn install

[DIWAKARKASHYAP]

There is no need to execute this command. Turbo is already part of the dependencies and will be installed if you execute yarn install

after execute yarn install and run yarn start:dev, it shows this

[mrdrogdrog]

You didn't fill out the issue template correctly. Can you give a bit more information about your system? What OS are you running? Which node version are you using?
These questions are there for a reason.

[DIWAKARKASHYAP]

window 11
yarn 3.6.4
node v18.18.0

[mrdrogdrog]

hm. Seems like dotenv can't find the turbo executable. Usually yarn modifies the PATH environment variable so subprocesses (dotenv in this case) can find other node_modules executable (turbo in this case). Seems like this doesn't work on windows.

You could try to execute this yarn run dotenv -c development -- yarn run turbo run start:dev.

However, I can't guarantee that our toolchain will work on win11 because it includes unixoid specific stuff like shell scripts.

[DIWAKARKASHYAP]

not working , end up with this error Usage Error: Couldn't find a script named "turbo".

[DIWAKARKASHYAP]

i have another question , can i raise a PR on changing developer documentation url with this https://docs.hedgedoc.dev/how-to/develop/setup/

[mrdrogdrog]

That should work

[ErikMichelson]

Let's keep things organized and therefore separated. I created the issue #5168 to further identify and then document the situation with Windows systems.

This issue is about links in the documentation.
As I already said, I'd like to have a broken-link-checker being run through the complete docs (and the special markdown files in the repo like readme, contributing, and so on).

I don't see much benefit for the HedgeDoc project in opening a separate PR for each broken link and honestly that looks actually like just Hacktoberfest-grinding to me.

So, for going onwards I really appreciate a full check and fixing of links in the docs and even better a GitHub actions workflow like we have it for our website being adapted and integrated.