skrub icon indicating copy to clipboard operation
skrub copied to clipboard

DOC - Reorganizing the "Development" section in the website top bar

Open rcap107 opened this issue 3 months ago • 4 comments

A general comment: in the "Development" section of the website, there are subsections including the one you want to add and "Contributing to skrub". "Contributing to skrub" is then also a section in the drop-down of "More". We might want to add an issue to clear this up.

Originally posted by @jovan-stojanovic in https://github.com/skrub-data/skrub/pull/1578#pullrequestreview-3173194089

rcap107 avatar Sep 01 '25 13:09 rcap107

Is the preferred option to have "Contributing to skrub" as part of the "Development" page rather than on its own (in the More dropdown)? Also would it make sense to rename this to just "Contributing"? Since the context is already within the skrub repo, "Contributing to skrub" might be a bit redundant.

divakaivan avatar Sep 06 '25 21:09 divakaivan

I think we can start by removing "Contributing to skrub" from the drop down menu, since it's already present in the "Development" page.

Something I would also like to do is rework the "Contributing to skrub" page so that the outline has less nesting, which is similar to what I am trying to do in #1574. This is a bit more complex, so for later.

rcap107 avatar Sep 08 '25 11:09 rcap107

#991 should also be addressed

rcap107 avatar Oct 10 '25 11:10 rcap107

To remove the "contributing" section from the bar, it is sufficient to edit doc/index.rst to remove CONTRIBUTING.

The documentation of the table report should be cleaned up (if needed) and moved to the doc folder so that it can be called from the development.rst TOC.

We might also consider reformatting a bit the Development outline if needed.

rcap107 avatar Oct 27 '25 14:10 rcap107