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

Documentation issue - images are not showing in the main branch #1117

Closed
rupeshs opened this issue Oct 16, 2022 · 8 comments
Closed

Documentation issue - images are not showing in the main branch #1117

rupeshs opened this issue Oct 16, 2022 · 8 comments
Assignees
Labels
enhancement New feature or request

Comments

@rupeshs
Copy link
Contributor

rupeshs commented Oct 16, 2022

This issue is with the main branch, the development branch is okay.

The following pages have this issue:
https://github.com/invoke-ai/InvokeAI/blob/main/docs/features/INPAINTING.md
https://github.com/invoke-ai/InvokeAI/blob/main/docs/features/OUTPAINTING.md

Seems like <div align="center" markdown> is causing it.

<div align="center" markdown>
![curly_woman](../assets/outpainting/curly.png)
</div>

image-issue

@mauwii
Copy link
Contributor

mauwii commented Oct 16, 2022

did you try to look at this documentation ;-)

@lstein
Copy link
Collaborator

lstein commented Oct 16, 2022

@mauwii is there some way to achieve centered images in both gh-pages and GitHub's plain-ol' markdown? For the time being I've removed the

tags, which restores the images when browsing the GitHub code, but loses the centering in gh-pages.

@lstein lstein added the enhancement New feature or request label Oct 16, 2022
@mauwii
Copy link
Contributor

mauwii commented Oct 16, 2022

imho the best way would be to just ask people to use the docs pages when want to read docs, besides that the only options I could think of atm are:

  • split them and use documentation/**.md for github formated docs while having mkdocs in docs/**.md.

imho not so good since the information available will pretty fast drift appart (some infos only in github docs, while others in mkdocs)

  • decide to have ugly mkdocs as well as ugly "browser-readable" github docs, both served from docs/**.md

also don't get it, why people cannot just use the mkdocs site to read docs (it even includes a search functionality which only searches docs and not the whole repository/code). Also the mkdocs are available offline if people complain to not have them with the repo (just pip install -r requirements-mkdocs an then "mkdocs serve")

Maybe there are other options but I am not aware of them 🙈

If I want to search f.E. for "embiggen" after knowing there was something mentioned which I would need now, this is the result of searching in the repo:

image

Yes - it didn't even find one file there (but maybe I need to type more than just embiggen in the GH-Search Bar to find what I was looking for, dunno 🤷🏻‍♂️)

while this is the mkdocs-search:

image

which, if I am searching for something in the documentation helps out much by not having to deal with issues, other code files, .... And I do not need to know any kind of filter terms, but only type the term I am looking for.

So maybe this explains a bit better what makes it hard for me to understand the benefit of using docs from GitHub vs f.E. MkDocs-Material via GH-Pages

@lstein
Copy link
Collaborator

lstein commented Oct 17, 2022

The problem is that the link to mkdocs is small and the README is large. Let’s change the README to point into the mkdocs Index.md file. Just some intro text and the logo in README, plus big. READTHEDOCS link.

@mauwii
Copy link
Contributor

mauwii commented Oct 17, 2022

Maybe I just had a great Idea: Why not leave the README.md as is, but point the links to the (Mk)Docs instead of docs/**.md

for example:

Features

Major Features

This would let people who just want to inform what the Repo has to offer still do so without changing to another site, while people who are looking for something specific get linked to the right place ^^

@lstein
Copy link
Collaborator

lstein commented Oct 17, 2022 via email

@mauwii
Copy link
Contributor

mauwii commented Oct 28, 2022

I guess this can be closed @lstein or @psychedelicious 🙈

@psychedelicious
Copy link
Collaborator

Closing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants