piccolo-orm / piccolo_admin

A powerful web admin for your database.
https://piccolo-orm.com/ecosystem/
MIT License
322 stars 39 forks source link

add custom links option in sidebar nav #308

Closed sinisaos closed 1 year ago

sinisaos commented 1 year ago

Related to #307.

codecov-commenter commented 1 year ago

Codecov Report

Merging #308 (f5566c2) into master (8fdebb5) will increase coverage by 0.07%. The diff coverage is 100.00%.

:exclamation: Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##           master     #308      +/-   ##
==========================================
+ Coverage   93.23%   93.31%   +0.07%     
==========================================
  Files           5        5              
  Lines         355      359       +4     
==========================================
+ Hits          331      335       +4     
  Misses         24       24              
Impacted Files Coverage Δ
piccolo_admin/translations/data.py 100.00% <ø> (ø)
piccolo_admin/endpoints.py 92.61% <100.00%> (+0.09%) :arrow_up:
sinisaos commented 1 year ago

@dantownsend I've updated the sidebar_links docstring and added an example. Is that enough because create_admin docs don't have a separate section for parameters, they are from the source code docstring?

dantownsend commented 1 year ago

@dantownsend I've updated the sidebar_links docstring and added an example. Is that enough because create_admin docs don't have a separate section for parameters, they are from the source code docstring?

I see what you're saying. It might be nice to have a screen grab, so people get a better idea of what it does.

Based on the current docs, we would probably need a new page called Sidebar Links or something.

sinisaos commented 1 year ago

I see what you're saying. It might be nice to have a screen grab, so people get a better idea of what it does.

Based on the current docs, we would probably need a new page called Sidebar Links or something.

I agree. I can do it, but I think it would be better if you do it, because I see that almost all screenshots are from Safari and Mac (and I don't have a Mac).

dantownsend commented 1 year ago

I agree. I can do it, but I think it would be better if you do it, because I see that almost all screenshots are from Safari and Mac (and I don't have a Mac).

OK, no problem.

Something like this might be OK, which doesn't have the border or address bar, so is browser / OS agnostic:

https://piccolo-admin.readthedocs.io/en/latest/_images/forms_sidebar.png

sinisaos commented 1 year ago

If that's the case, I can try to make docs with screenshots and make a new commit.

dantownsend commented 1 year ago

If that's the case, I can try to make docs with screenshots and make a new commit.

Thanks!

dantownsend commented 1 year ago

Made some minor changes:

dantownsend commented 1 year ago

@sinisaos If you're happy with the changes I made, will merge it in tomorrow.

sinisaos commented 1 year ago

@dantownsend Your changes look great. Thanks. Feel free to merge it.