Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature] API docs theme #197 #277

Merged
merged 5 commits into from
Feb 12, 2022

Conversation

Aryamanz29
Copy link
Member

@Aryamanz29 Aryamanz29 commented Jan 27, 2022

Closes #197

Changes

  • Changed API docs theme to look similar to admin

Screenshots

BEFORE

Screenshot from 2022-02-06 22-52-44

Screenshot from 2022-02-11 16-04-32

AFTER

login-2022-02-06_22.31.45.mp4
login-2022-02-11_15.57.21.mp4

Checklist

  • I have read the contributing guidelines.
  • I have manually tested the proposed changes.
  • I have written new test cases to avoid regressions. (if necessary)
  • I have updated the documentation. (e.g. README.rst)
  • I have added [change!] to commit title to indicate a backward incompatible change. (if required)
  • I have checked the links added / modified in the documentation.

@Aryamanz29 Aryamanz29 force-pushed the issue-197/api-doc-theme branch 2 times, most recently from 8af0926 to f48de4f Compare January 28, 2022 22:07
@coveralls
Copy link

coveralls commented Jan 28, 2022

Coverage Status

Coverage remained the same at 98.618% when pulling 64dbbb1 on Aryamanz29:issue-197/api-doc-theme into deb4af2 on openwisp:master.

@Aryamanz29
Copy link
Member Author

Aryamanz29 commented Jan 28, 2022

@nemesisdesign Do I have to make changes in OP block styles as well to look similar to admin-theme? 😅

Screenshot from 2022-01-29 03-44-55

@nemesifier
Copy link
Member

@nemesisdesign Do I have to make changes in OP block styles as well to look similar to admin-theme? sweat_smile

Screenshot from 2022-01-29 03-44-55

No this one let's not touch it.

Copy link
Member

@nemesifier nemesifier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you very much for your great work, is looking really good, let's make some more improvements!

Swagger UI

Can you please make the authorize button look like:

Screenshot from 2022-02-11 11-51-35

Also, would be nice to switch the color of links (<a> elements) to the same color we use in the openwisp admin, making sure the links are not bold.

Take a look also at these buttons please (which do not look right):
Screenshot from 2022-02-11 11-59-02

DRF browsable API

Here it is what I suggest:

  • remove the gird background
  • make the header background white
  • make the logo and spacing around it similar to what's in the swagger API
  • the labels of the form I would try to remove the bold and make it full black (#000)
  • the tabs in the form, let's not make the background reddish but keep the background consistent with the rest of the form box, the background color on hover could be slightly lighter (eg: #f9f9f9)

@Aryamanz29
Copy link
Member Author

Aryamanz29 commented Feb 12, 2022

Swagger UI

  • Screenshot from 2022-02-11 11-51-35

  • Also, would be nice to switch the color of links (<a> elements) to the same color we use in the openwisp admin, making sure the links are not bold.

NOW

Screenshot from 2022-02-12 15-06-45

  • Take a look also at these buttons please (which do not look right): Screenshot from 2022-02-11 11-59-02

NOW

Screenshot from 2022-02-12 15-29-54

DRF browsable API

  • remove the gird background
  • make the header background white
  • make the logo and spacing around it similar to what's in the swagger API
  • the labels of the form I would try to remove the bold and make it full black (#000)
  • the tabs in the form, let's not make the background reddish but keep the background consistent with the rest of the form box, the background color on hover could be slightly lighter (eg: #f9f9f9)

NOW

Screenshot from 2022-02-12 15-09-12

Screenshot from 2022-02-12 15-09-23

Copy link
Member

@nemesifier nemesifier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@nemesifier nemesifier merged commit ae5df39 into openwisp:master Feb 12, 2022
@Aryamanz29 Aryamanz29 deleted the issue-197/api-doc-theme branch February 17, 2022 01:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[feature] API docs theme
3 participants