clay icon indicating copy to clipboard operation
clay copied to clipboard

Convert the main page readme to a wiki?

Open cugone opened this issue 8 months ago • 4 comments

The main page readme is quite long and might be better served as a multi-page, searchable github wiki.

cugone avatar Mar 06 '25 00:03 cugone

I think the README is actually preferable at the moment:

  • it's a part of the code, which means that if you need to look something up, you can open the file up in the text editor, where you're likely working anyway.
  • table of contents makes it fairly easy to find & jump to entries.
  • the README is close to the code, so hopefully it will be easier to keep in sync with code changes. I have seen too many horrendously out of data wikis 😅

Nelarius avatar Mar 14 '25 03:03 Nelarius

There was actually an earlier issue about this: https://github.com/nicbarker/clay/issues/60

Nelarius avatar Mar 14 '25 04:03 Nelarius

There was actually an earlier issue about this: #60

And Nic himself even said it was a good idea.

cugone avatar Mar 14 '25 04:03 cugone

Information on github wikis is always hard to find because they're not indexed by search engines. Many projects avoid them for this reason.

For details see: Permit search engines to index Github wikis #4992

(I have no stake in this, just chiming in.)

pengowray avatar Apr 03 '25 04:04 pengowray