search

alan-turing-institute / uatk-spc

Synthetic Population Catalyst
https://alan-turing-institute.github.io/uatk-spc/
MIT License
21 stars 12 forks source link

Suggestion for Docs structure #21

Closed mfbenitezp closed 2 years ago

mfbenitezp commented 2 years ago

Suggestion for Doc structure: I need to double check grammar, typos or links, but just to see if it is a clear structure. I tried to wear the shoes of an external researcher.

dabreegster commented 2 years ago

I'm still not sure about the structure.

1) Code that reads and uses the output files feels more important than running SPC. 2) Separating installation and troubleshooting feels unnecessary -- the pages aren't long, and they're quite related @darribas, @HSalat - if you have time, could you check out the old/new site and weigh in?

There's lots of word spelling stuff I spot, but I can make an editing pass once we settle on structure

HSalat commented 2 years ago

Sorry, which is the new site and which is the old?

My point of view is the same as I mentioned on Slack. Make a very simple "table of contents" page and let the user decide what is important to them.

I would separate the troubleshooting for the simple reason that that way anyone looking at the site knows immediately where to click when they encounter a problem.

dabreegster commented 2 years ago

Old: https://alan-turing-institute.github.io/uatk-spc/ New: You can view the files in this PR, or more easily, 'gh pr checkout 21; cd docs; quarto preview' (assuming you've set up the github CLI and quarto)