Skip to content

ADD info regarding limits (from faq)#380

Open
GithubAnon0000 wants to merge 7 commits into
ankitects:mainfrom
GithubAnon0000:add-file-limits
Open

ADD info regarding limits (from faq)#380
GithubAnon0000 wants to merge 7 commits into
ankitects:mainfrom
GithubAnon0000:add-file-limits

Conversation

@GithubAnon0000

@GithubAnon0000 GithubAnon0000 commented May 18, 2025

Copy link
Copy Markdown
Contributor

Depends on #403.

This adds the info from the FAQ section into the manual.

Notable Changes

  1. The incorrect info "250MB" has been updated to "300MB". See Update limit from 250 to 300MB. faqs#46.
  2. I made the sections atomic.
  3. I updated the "Tools>Media" part to adhere to the manuals style guide.
  4. I reduced the amout of words on some sections.
  5. I sometimes added the response / answer first (prepended "yes" or "no").
  6. I used admonitions faq style, collapsed by default.

Screenshots

Current entry in the FAQ:

anki

Entry in the docs, if this PR is merged:

anki

[Old] Entry in the docs, if this PR is merged:

anki


Pinging @brishtibheja.

@dae

dae commented May 19, 2025

Copy link
Copy Markdown
Member
  • These associated question feel a bit too short individually to justify having their own TOC entry each. How about bolding the titles instead of making them headings, and using a single new heading?
  • Compressed/uncompressed is confusing to some users, and the user is much more likely to hit the uncompressed limit, which is what is also shown in the message. What about just saying "an uncompressed size of 300MB" and dropping the compressed limit?
  • These days, users who sync with a too-large collection will get a message notifying them as such - they won't get a message about the collection being corrupt.

@GithubAnon0000

GithubAnon0000 commented May 20, 2025

Copy link
Copy Markdown
Contributor Author
  • These associated question feel a bit too short individually to justify having their own TOC entry each. How about bolding the titles instead of making them headings, and using a single new heading?

I agree regarding the own TOC entry. Though making the text bold (without it being a heading) removes the margins as well, which negatively impacts readability.

I could solve it, in theory, but I don't know if you'd accept that:
anki

These headers don't appear in the toc, because they aren't headers. Instead, I added the following into the .md file:

<div style="margin: 2em 0 0.5em 0; font-weight: bold; font-size: 1.5em;">Are there limits on file sizes on AnkiWeb?</div>

The styling could easily be put into a class in our custom css file.

Limitations

  1. This doesn't act as a clickable link.

  2. This makes it neccessary to add a blank line under the div (or else markdown formatting might not be applied properly). This impacts readability in the source files themselves, but not in the final html view:
    anki

  3. This would mean adding divs, which might be unwanted in a .md file.


Do you have any ideas to solve this?

@GithubAnon0000 GithubAnon0000 marked this pull request as draft May 25, 2025 15:07
@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

Another idea:

We could use a normal code block and give it a language that doesn't exist, like so:

```custom_question
Are there limits on file sizes on AnkiWeb?
```/*ignore me. I make githubs codeblock work.*/

Yes.

- **Collection limit**: 300MB (uncompressed).

- **Media limit**: No limit for the total amount of media, but 100MB for
individual media files.

The collection includes the text on your cards and the scheduling information,
but does not include media (sounds and images), as they are stored separately.

We then could put the following into misc.css:

.language-custom_question {
    /* Turn off codeblock stuff */
    background: initial;
    padding: 0;
    font-family: "Open Sans", sans-serif !important; /* This is the default font */
    font-size: initial;
    
    /*Style it*/
    margin: 2em 0 0.5em 0;
    font-weight: bold;
    font-size: 1.5em;
}

Issues

  1. While this does increase readability in the final render, it decreases readability in the .md file itself.
  2. It has a Copy button on hover, which I cannot really remove without js.

Pictures

anki


anki

Question

Do you think it might be worth changing the program that creates our toc? It would solve this issue here and also #373. Though we might need a custom program that does what we need...

@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

I now used admonitions. See updated description for an image.

This is ready for review now.

@GithubAnon0000 GithubAnon0000 marked this pull request as ready for review June 3, 2025 19:28
@dae

dae commented Jun 4, 2025

Copy link
Copy Markdown
Member

These don't seem to render correctly for me - could it be a different approach is required after 9bf2a64?

@brishtibheja

Copy link
Copy Markdown
Contributor

Is the space between backticks and admonish the issue :think:

example of another book using this preprocessor: https://github.com/rhaiscript/book/blob/master/src/about/features.md?plain=1

@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

These don't seem to render correctly for me

You need to merge the changes of #403 first:

Depends on #403.

Otherwise, it just gets rendered as a code block without special styling.

@dae

dae commented Jun 4, 2025

Copy link
Copy Markdown
Member

Sorry, I still haven't caught up on the manual PRs, and completely overlooked that first line. Will circle back to this hopefully tomorrow.

@dae

dae commented Jun 5, 2025

Copy link
Copy Markdown
Member

Not sure how I feel about them all being collapsed by default. If the user is curious, they're likely going to click each of them in turn to reveal them - and that's a waste of time compared to just being able to read the page without clicking. WDYT @Danika-Dakika?

@Danika-Dakika

Copy link
Copy Markdown
Collaborator

I can tell that this and #406 are to take more than a couple minutes for me to connect all the dots. Hopefully I can give this a look this weekend!

@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

That's fine. It would be great if it could be reviewed in the next 2-4 weeks, just so that I know PRs are actively reviewed;1 but it doesn't have to be done immediately.

Footnotes

  1. This, unfortunately, isn't too common in open source projects. Even in larger projects it sometimes takes more than a month (maybe even much longer than that) for someone to review it. I get discouraged in that case. But here in Anki it's generally quite fast, which is nice.

@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

[Going through old PRs and closing them. I won't have enough time to update the PRs or develope them further for probably a few months. In case someone wants to continue here, feel free to so.]

@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

I realized I mistakenly closed PRs that should've been kept open. I was in a flow state and just closed stuff without reading...

Sorry about that! Re-opening...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants