bit icon indicating copy to clipboard operation
bit copied to clipboard

Typo in docs/intro

Open CodeLikeAGirl29 opened this issue 1 year ago • 2 comments

I found a typo in the README.md file.

URL: bit.dev/docs/intro Line: 13 Typo: Make sure to create your scope on the Bit platform and use the right org and project name. After running the command, Bit is initialized on the chosen directory, and ready to be used via Bit commands, your editor or the Bit UI! Corrected Text: Make sure to create your scope on the Bit platform and use the right org and project name. After running the command, Bit is initialized on the chosen directory, and ready to be used via Bit commands, your editor or the Bit UI!

Thank u!

CodeLikeAGirl29 avatar Apr 09 '24 02:04 CodeLikeAGirl29

@CodeLikeAGirl29 , I was reading it 5 times and even put them in an online diff, the original text and the "Corrected Text" are identical :)

davidfirst avatar Apr 29 '24 14:04 davidfirst

it was actually the link that was bad!

CodeLikeAGirl29 avatar May 13 '24 23:05 CodeLikeAGirl29

OK, so I guess it's all good now. I checked the link and it has the same text as the "Corrected Text" above.

davidfirst avatar May 14 '24 18:05 davidfirst

@davidfirst I ran into this just now. The link is broken. When I click on create your scope on the Bit platform it links to https://bit.cloud/singup when it should link to https://bit.cloud/signup.

Please reopen.

This is such a silly mistake. I would expect to see the documentation checked into source, so I can just go ahead and fix it myself. But I can't find the introduction section in this repository: https://github.com/search?q=repo%3Ateambit%2Fbit+Welcome+to+the+Bit+documentation.&type=code

It seems as if the documentation is not part of this repository :sob:

I googled "bit.dev documentation source code" and found https://github.com/teambit/docs which is archived. Where is the source for the documentation website?

I found at least two more typos:

  1. https://bit.cloud/teambit/documenter it is "documentation" not "documantation"
  2. https://bit.dev/docs/getting-started/composing/dev-environments#compose-your-own-dev-environment button "typescript" links to https://bit.dev/docs/node-components/node-modules which gives 404

roschaefer avatar Jun 12 '24 18:06 roschaefer