Halide icon indicating copy to clipboard operation
Halide copied to clipboard

[docs] Need user-facing scheduling guide

Open derek-gerstmann opened this issue 1 year ago • 4 comments

Start with adding Wiki placeholder pages

derek-gerstmann avatar Oct 27 '23 21:10 derek-gerstmann

My current concern with the Wiki a little bit is that there is no subfolder feature on Github. This means we should do one or more of the following:

  • Delete the GSoC pages?
  • Merge the GSoC pages into one .md file?
  • Manually maintain the sidebar by writing a custom _Sidebar file.
  • Prefix the filenames with a alphanumeric sortable prefix to get Github to automatically structure it. Perhaps just 01, 02, etc for the chapters.

The Wiki currently is rather unstructured, and the pages that are there in the sidebar are rather loose, standalone (and sometimes outdated?) chunks of info. A rather lengthy Wiki I know of is the Jai-Community-Library. https://github.com/Jai-Community/Jai-Community-Library/wiki They maintain the sidebar manually to make it structured. And it seems to work for them. A nice bonus for a few very long wiki-pages is searchibility with Ctrl-F.

mcourteaux avatar Oct 30 '23 09:10 mcourteaux

Started a new Wiki page here https://github.com/halide/Halide/wiki/Scheduling-Tips

derek-gerstmann avatar Mar 01 '24 20:03 derek-gerstmann

Can we retire the GSoC pages? They are ugly on the sidebar, and 3 years old. I don't know if anyone at google (@steven-johnson, @vksnk) wants to keep those around? If you wish to keep them, I could perhaps merge them into a single GSoC page, instead of one page per topic.

mcourteaux avatar Jun 12 '24 08:06 mcourteaux

FWIW, GSoC is a program sponsored by Google to encourage students to contribute into open-source projects, but I don't think these projects for Halide were suggested by anyone specifically at Google. It does seem like a good idea to at least combine them into a single page.

vksnk avatar Jun 12 '24 16:06 vksnk