website icon indicating copy to clipboard operation
website copied to clipboard

Docs restructure

Open ewels opened this issue 1 year ago • 2 comments

Results of a day's hacking by @mashehu and @ewels

Still a lot left to do, see project board: https://github.com/orgs/nf-core/projects/67/views/1

Deployment preview: https://deploy-preview-2441--nf-core.netlify.app/docs

@netlify /docs

ewels avatar Apr 05 '24 15:04 ewels

Deploy Preview for nf-core ready!

Name Link
Latest commit 82b34cfe6b6f7b2265015b67a52d68a0e8fb1805
Latest deploy log https://app.netlify.com/sites/nf-core/deploys/6647db471a6a0f00088e5c5a
Deploy Preview https://deploy-preview-2441--nf-core.netlify.app/docs
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Apr 05 '24 15:04 netlify[bot]

Sidebar is now working on everything and I tried to introduce a 3rd-level to the usage docs. We need to decide a place for the API docs, fix the merge conflicts and then we should be good to go for the first roll-out.

mashehu avatar Apr 13 '24 10:04 mashehu

Last comments :)

  • The link to "join the community" here is outdated
  • The link to the #test-data Slack channel is pointing to the wrong channel.

mirpedrol avatar May 14 '24 15:05 mirpedrol

My only remaining comment currently is that I strongly feel that we need to distinguish between ipeline users docs (of all kinds) vs pipeline developer docs (of all kinds).

I Personally feel splitting the current cards into two sections based on this is a worthwhile cause for that purpose, even if it makes the page a little londer.

But I give my approval as the general over haul is a good star in that direction

jfy133 avatar May 15 '24 12:05 jfy133

@mirpedrol - These links just go to the PR and not a specific location. Most of them I've been able to find myself, but I don't know where this one was.. Do you remember?

ewels avatar May 17 '24 12:05 ewels

ok, merge conflicts fixed and (I think) all previous URLs still working / redirected in case they are referred to from anywhere.

Still more to do, but I think that this is as good as it's going to get for the merge on this PR.

ewels avatar May 17 '24 22:05 ewels