themesberg / themesberg/flowbite

Document tutorial for Django html snippets refer to images on doc site as though local, so they are not found.

Open
#651 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
9.4k
Forks
862
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
The _base.html and index.html examples refer to images "/docs/image/logo.svg" and "/docs/images/blog/image-1.jgp". There is no step in the tutorials to install these files locally, so the references get 404s.

To Reproduce
Steps to reproduce the behavior:

  1. Follow the tutorial to the point where the _base.html is in use in the index page. View the page, note that the logo is missing from the navbar, and that the server reports a 404 response.
  2. Continue the tutorial to the point where the button is added to index.html. View the page, note that the image is not displayed and the server reports a 404 response for "/docs/image/blogs/image-1.jpg".

Expected behavior
The image tags to work

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: Linux
  • Browser: Brave
  • Version: 115

Additional context
When I changed the "/docs/..." refs to "https:flowbite.com/docs/..." everything worked, both image appeared. Maybe you should just do that in the docs.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the tutorial examples in _base.html and index.html, starting with the image references described in the issue. Follow the tutorial through both image usages and verify that the rendered pages load the images without 404 responses; done means the examples work for a local tutorial setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.