penrose icon indicating copy to clipboard operation
penrose copied to clipboard

improve wiki docs to clarify audience and FAQ

Open kai-qu opened this issue 4 years ago • 3 comments

  • Clarify who each page is for
  • Answer some FAQs ("how to make a label in Sub/Sty/DSL" "why isn't my shape showing up on canvas" etc)
  • Document use of inspector
  • Make sure GitHub search results are clean

Reported by P3 domain expert on 5/21/21

kai-qu avatar May 26 '21 20:05 kai-qu

As @maxkrieger mentioned in https://github.com/penrose/penrose/pull/771#issuecomment-1008518452, we should migrate everything off the wiki and onto our docsaurus site.

samestep avatar Jan 15 '22 18:01 samestep

As @maxkrieger mentioned in https://github.com/penrose/penrose/pull/771#issuecomment-1008518452, we should migrate everything off the wiki and onto our docsaurus site.

@joshsunshine Is this accurate? I seem to remember there being some discussion in January about how we actually might not want to put everything on the website (e.g. stuff that's just for developers of Penrose, rather than users). What was the conclusion of that discussion?

samestep avatar May 11 '22 12:05 samestep

For the record I'm still in favor of throwing everything on the central docs site (most repos do this) - I don't remember us having a reversal

maxkrieger avatar May 11 '22 14:05 maxkrieger

Closing since this issue is out-of-date

wodeni avatar Jan 17 '23 21:01 wodeni