sandboxie-plus / sandboxie-docs

Sandboxie Documentation
https://sandboxie-plus.github.io/sandboxie-docs
70 stars 50 forks source link

Adopt MkDocs and use Read the Docs theme #167

Closed QZLin closed 1 month ago

QZLin commented 5 months ago

https://qzlin.github.io/sandboxie-docs

isaak654 commented 5 months ago

Unless you click the plus buttons, it is not possible to directly access "Sandboxie Control" and "SBIE Messages" with Firefox 124.0.2 and MS Edge 123.0.2420.81:

https://github.com/sandboxie-plus/sandboxie-docs/assets/12372772/b56d7b46-969a-40f5-af89-2f6eb5810a04

QZLin commented 5 months ago

That seems the expected behaviour of the mkdocs default readthedoc theme. I will try to change it.

isaak654 commented 5 months ago
  1. If you go into the "Usage Tips" page, the minus button is still displayed even when there is nothing below to collapse
  2. The Sandboxie logo feels empty without a sandboxie-docs text next to it
  3. Search highlighting doesn't seem to be supported in the theme, so this can be skipped and postponed later
isaak654 commented 2 months ago

I think it would be better if the text was part of the logo itself.

In this regard, I wonder if it is possible to reproduce a yellow font similar to this one: 105014988-575cb680-5a41-11eb-90d5-d942d28184b2.png

QZLin commented 2 months ago

a merged logo sandmerge

isaak654 commented 2 months ago

I'm thinking of something more recognizable like this:

342063615-87df6d8d-4a1c-4ddd-b248-5c20e42b84d7_v3

where "docs" is Segoe UI Bold 24 pt

Old result (.logo width is set to 200px):

logo preview

Graphic defects:


New attempts with "docs" set as centered and with font size 30 pt:

"docs" set as centered and with font size 30 pt "docs" set as centered and with font size 30 pt (yellow variant)


New attempts (text only, without icon):

Sandboxie text only (logo) Sandboxie text only (logo v2)

QZLin commented 2 months ago

Cleaned up the leftover pixels and add shadow to "docs" text sandmerge Preview with background color: preview

isaak654 commented 1 month ago

I have merged the previous PRs and decided which logo to adopt.

Could you help me to fix the following points before merging?

QZLin commented 1 month ago

https://github.com/sandboxie-plus/sandboxie-docs/pull/167#issuecomment-2259102580

The logo link seems broken (Got 404 not found)

isaak654 commented 1 month ago

The logo link seems broken (Got 404 not found)

Not anymore, I've just updated the link.

QZLin commented 1 month ago

https://github.com/QZLin/sandboxie-docs/commit/85fd13c67336b62588401c4dbad68ca5d4ed92b1 I'm not sure if splitting the readme into repo readme and docs readme is a good idea. But the links of readme.md and docs/readme.md have to be different because of the mkdocs project structure.Then we will have to always do the sync jobs for two similar files.

// readme.md
[Getting Started with Sandboxie](docs/Content/GettingStarted.md)

// docs/readme.md
[Getting Started with Sandboxie](Content/GettingStarted.md)
isaak654 commented 1 month ago

I'm not sure if splitting the readme into repo readme and docs readme is a good idea.

I think renaming docs/readme.md to docs/index.md could help to prevent confusion, while in the root README:

# Sandboxie documentation

README is located at [docs/index.md](docs/index.md).

A second alternative would be the content of: https://github.com/okrc/sandboxie-docs/blob/cd3e116b3fb817386eee5edc26fb99bb5d3dfe83/docs/index.md

but to make a decision we should have a list of pros and cons.

isaak654 commented 1 month ago

The search box under the logo suddenly disappeared.

QZLin commented 1 month ago

The search box under the logo suddenly disappeared.

Fixed