pulsar icon indicating copy to clipboard operation
pulsar copied to clipboard

docs: add developers-landing page to sidebars

Open tisonkun opened this issue 3 years ago • 4 comments

This is a followup to #17284.

cc @DaveDuggins @Anonymitaet @momo-jun @urfreespace

Documentation

  • [ ] doc-required (Your PR needs to update docs and you will update later)

  • [ ] doc-not-needed (Please explain why)

  • [x] doc (Your PR contains doc changes)

  • [ ] doc-complete (Docs have been already added)

Matching PR in forked repository

docs only change

tisonkun avatar Sep 21 '22 15:09 tisonkun

Currently, this page is dangling:

image

tisonkun avatar Sep 21 '22 15:09 tisonkun

Hi tison! This page does not require sidebar links. The landing pages I'll be creating PRs for over the next few days will not require a sidebar link. These pages serve only as a connection point between the content blocks on the main documentation page and the topics. No additional navigation is needed.

DaveDuggins avatar Sep 21 '22 17:09 DaveDuggins

@DaveDuggins this patch doesn't add a new entry but reuse the "development" entry.

If we don't add it to the sidebars, how can users find the page? Only by entering the exact url? It seems unreasonable.

tisonkun avatar Sep 21 '22 18:09 tisonkun

@DaveDuggins OK. I see the link from the original patch. Let me show you the result of this patch in preview later today.

tisonkun avatar Sep 21 '22 19:09 tisonkun

cc @DaveDuggins

Current:

https://user-images.githubusercontent.com/18818196/191638058-655aec16-0d91-4ef6-abaa-06a65ec50c91.mov

Preview with this patch:

https://user-images.githubusercontent.com/18818196/191638238-9e18bc4d-1995-4598-9fd7-4fbe70a69060.mov

tisonkun avatar Sep 22 '22 01:09 tisonkun

ping @DaveDuggins @Anonymitaet @momo-jun @urfreespace for another turn.

tisonkun avatar Sep 23 '22 06:09 tisonkun

@DaveDuggins this patch doesn't add a new entry but reuse the "development" entry.

If we don't add it to the sidebars, how can users find the page? Only by entering the exact url? It seems unreasonable.

No, by clicking the appropriate topic box on the main documentation page. These landing pages only serve as a bridge to the related articles linked from the content blocks on the main doc page.

DaveDuggins avatar Sep 23 '22 14:09 DaveDuggins

@DaveDuggins Yep. Please read the following comment for preview. This change won't break existing things and as an improvement.

tisonkun avatar Sep 23 '22 14:09 tisonkun

@DaveDuggins @momo-jun @urfreespace @Anonymitaet shall we merge this patch now?

tisonkun avatar Sep 27 '22 09:09 tisonkun