Documentation issue - images are not showing in the main branch

[rupeshs]

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>

[mauwii]

did you try to look at this documentation ;-)

[lstein]

@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.

[mauwii]

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:

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:

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]

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]

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

• Web Server
• Interactive Command Line Interface
• Image To Image
• Inpainting Support
• ...

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]

That’s a great idea. L

On Mon, Oct 17, 2022 at 4:21 PM Matthias Wild ***@***.***> wrote: 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 - Web Server <https://invoke-ai.github.io/InvokeAI/features/WEB/> - Interactive Command Line Interface <https://invoke-ai.github.io/InvokeAI/features/CLI/> - Image To Image <https://invoke-ai.github.io/InvokeAI/features/IMG2IMG/> - Inpainting Support <https://invoke-ai.github.io/InvokeAI/features/INPAINTING/> - ... 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 ^^ — Reply to this email directly, view it on GitHub <#1117 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAA3EVL4ARTMB55XS33VURTWDWYNRANCNFSM6AAAAAARGFYXFM> . You are receiving this because you commented.Message ID: ***@***.***>

-- Written on my cell phone. Anything that seems odd is the fault of auto-correct.

[mauwii]

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

[psychedelicious]

Closing