Skip to content

Docs website inconsistent UX #41

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.

Sign up for GitHub

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

Jump to bottom
Closed
3 of 4 tasks
heitorlessa opened this issue May 28, 2020 · 1 comment
Closed
3 of 4 tasks

Docs website inconsistent UX #41

heitorlessa opened this issue May 28, 2020 · 1 comment
Assignees
@heitorlessa
Labels
bug Something isn't working

Comments

@heitorlessa
Copy link
Contributor

heitorlessa commented May 28, 2020 •
edited
Loading

Issue to track following fixes as observed when used across browsers and builds:

  • Major: Chrome service workers are not being refreshed with latest build
    • Action: remove offline plugin
  • Minor: Logo link not returning to homepage
  • Minor: Logo not appearing in Mobile version
  • Minor: API docs side bar doesn't have a link to return to main docs
    • Action: Create custom [mako template for pdoc](https://github.com/pdoc3/pdoc/blob
      /master/pdoc/templates/html.mako)
    • Using custom templates yields all sort of issues despite only needing to add a A tag. As we're no longer showing API ref results in the search, ignoring this now
@heitorlessa heitorlessa added the bug Something isn't working label May 28, 2020
@heitorlessa heitorlessa self-assigned this May 28, 2020
heitorlessa referenced this issue in heitorlessa/aws-lambda-powertools-python May 28, 2020
@heitorlessa
fix: remove offline plugin #41
9222244 
Signed-off-by: heitorlessa <[email protected]>
heitorlessa referenced this issue in heitorlessa/aws-lambda-powertools-python May 28, 2020
@heitorlessa
fix: correct logo link #41
dd15e5e 
Signed-off-by: heitorlessa <[email protected]>
heitorlessa referenced this issue in heitorlessa/aws-lambda-powertools-python May 28, 2020
@heitorlessa
fix: search header grey background #41
6afe312 
Signed-off-by: heitorlessa <[email protected]>
@heitorlessa heitorlessa mentioned this issue May 28, 2020
Merged
@heitorlessa
Copy link
Contributor Author

API results no longer showing in the search - algolia/docsearch-configs#1998

heitorlessa added a commit that referenced this issue May 28, 2020
@heitorlessa
Docs: fix minor UX issues (#42)
4b03ddc 
* fix: remove offline plugin #41

Signed-off-by: heitorlessa <[email protected]>

* fix: correct logo link #41

Signed-off-by: heitorlessa <[email protected]>

* fix: search header grey background #41

Signed-off-by: heitorlessa <[email protected]>

* improv: limit docs api dep to speed up CI

Signed-off-by: heitorlessa <[email protected]>
heitorlessa referenced this issue in heitorlessa/aws-lambda-powertools-python Jun 17, 2020
@heitorlessa
Docs: fix minor UX issues (#42)
08f98da 
* fix: remove offline plugin #41

Signed-off-by: heitorlessa <[email protected]>

* fix: correct logo link #41

Signed-off-by: heitorlessa <[email protected]>

* fix: search header grey background #41

Signed-off-by: heitorlessa <[email protected]>

* improv: limit docs api dep to speed up CI

Signed-off-by: heitorlessa <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@heitorlessa heitorlessa

Labels
bug Something isn't working
Projects
Powertools for AWS Lambda (Python)
Status: Triage
Milestone
No milestone
Development

No branches or pull requests
1 participant
@heitorlessa