search

spf13 / cobra

A Commander for modern Go CLI interactions
https://cobra.dev
Apache License 2.0
37.97k stars 2.85k forks source link

404 links on https://cobra.dev/ #1391

Open jelly opened 3 years ago

jelly commented 3 years ago

The documentation page contains links to how to setup bash completion / man page completion but those links are 404:

https://cobra.dev/doc/md_docs.md https://cobra.dev/doc/rest_docs.md https://cobra.dev/doc/man_docs.md https://cobra.dev/bash_completions.md

github-actions[bot] commented 3 years ago

This issue is being marked as stale due to a long period of inactivity

umarcor commented 2 years ago

Duplicate of #1243.

johnSchnake commented 2 years ago

It may have been a duplicate but the other issue is now closed whereas the broken links remain. Still needs fixed it seems.

umarcor commented 2 years ago

@johnSchnake see the references in #1243:

karansuryadevra commented 2 years ago

Hey @johnSchnake , Is this issue still open to be fixed?

fseesink commented 2 years ago

In the Using the Cobra Generator section, the link in the sentence

Here you can find more information about it.

is pointing to a non-existent page. This is due to the fact they are trying to go to

https://github.com/spf13/cobra/blob/master/cobra/README.md

when it should be

https://github.com/spf13/cobra-cli/blob/main/README.md
fseesink commented 2 years ago

Since we're on the subject, the entire page could use a little love and attention. It feels like maybe the framework is getting a lot of work/changes, but the website isn't keeping up.

The main page makes reference to the cobra command, when apparently it is now cobra-cli. And trying to follow the instructions on that main page leads to heartache if you don't spend time digging around. (I know, as I just started tinkering with this today. I got it sorted, but no thanks to this page.)

Also, the example code provided in the snippets is often incomplete, lacking package statements, etc. For those who aren't able to get the cobra-cli confusion sorted and try to use this framework manually, they are also in for a world of hurt if they try copy/pasting the snippets into the files and just using that as a baseline.

davidlopezre commented 1 year ago

Hey!

I noticed the docs in this GitHub repo are updated more frequently than the website. I think the docs in this repo are more likely up to date as they are next to the code. Also, it would be less confusing to have a single source of documentation. So, I wonder if we should remove the docs from the website and link to the GitHub README.

cc: @marckhouzam sorry for the direct mention, wanted a contributor opinion. I am happy to work on this but want to check if it sounds good to you.

Parthiv-M commented 1 year ago

Hi, this sounds super relevant as I fell prey to a couple of the stale links myself. Open to working on this if there's confirmation about working on this issue :)

umarcor commented 1 year ago

See https://github.com/spf13/cobra/pull/1984.

mloskot commented 9 months ago

I'm new to Cobra and the 404-s seem quite unhelpful. Is there any chance this can be fixed soon?

marckhouzam commented 9 months ago

@umarcor has been kindly trying to fix this for a while, and the maintainers have finally got time to look into the proposed PRs. I’m hoping this will be fixed soon.

pierow2k commented 2 months ago

Wound up here after trying to run down some documentation related to generating a man page. The links on cobra.dev under Generating documentation for your command are still broken.