Skip to content

Conversation

@brishtibheja
Copy link
Contributor

Some of the pages here have already been moved. So, I'm emptying them out and linking to the manual.

@Danika-Dakika
Copy link
Collaborator

Danika-Dakika commented Jun 2, 2025

[A PR that proposes moving/removing 6 unrelated pages is hard to review. In the future, please follow the principle of Do One Thing.]

There's more work that needs to be done on this PR before we can review it.

  1. Did you decide for each of these pages that the manual is the right place for this documentation, and not the FAQ? Just because there's something similar in both places doesn't tell you much about whether it properly belongs in the manual or the FAQ. So if you already thought that through, please include that explanation in this PR. [I assume this proposal is related to Move content into the manual #39, so understanding the reasons here will help us lay the groundwork for making those decisions in the future.]

  2. Have you gone through each of these pages and reconciled the FAQ text against the text in the manual to ensure we're not losing anything significant? If so, please use this PR to document what you compared. If you're proposing removing things that aren't otherwise documented, please explain why. [I started trying to compare these, but better that task start with the person making the proposal, than with me trying to guess your reasons.]

  3. Have you searched the major support channels (the Forums, Discord server, Reddit r/Anki) to assess whether any of these FAQ pages are so frequently used/linked-to that it's appropriate for them to remain in the FAQ?

  4. If we're removing pages entirely, and they really don't belong in the FAQ -- there's a more elegant way to do this than leaving hollow husks of the pages. I'm writing up instructions for how I've done this before with an immediate redirect (see Update README.md anki-manual#393). But this may be something to decide on a case-by-case basis depending on which FAQ page it is.

@brishtibheja
Copy link
Contributor Author

A PR that proposes moving/removing 6 unrelated pages is hard to review. In the future, please follow the principle of Do One Thing.

Do you think I should make multiple PRs one for each page? I'd like to get dae's opinion on this.

Now addressing the other points:

  1. This was done as part of this issue: Move FAQs' Content to the Manual anki-manual#275)

To quote dae:

That's fine, but old Anki versions directly link to the old pages, so we'll probably want to either keep around the old pages and have them link to the new location (latter is better for maintenance).

I think dae decided that we don't keep FAQs here but I see you think otherwise. I'll let dae make the call.

FYI the pages I emptied out in this PR all had their info migrated to manual as part of the above linked issue. I just forgot to make the additional changes in FAQs which is what I'm doing here.

  1. I didn't compare but you might find this issue relevant:update falling behind section anki-manual#306

The FAQ page very briefly explains how Anki determines the next interval when there is a longer delay than the interval. But, I figured with more people opting for FSRS maybe the novices wouldn't read it and the experts wouldn't need it.

Also, I removed the old method of customising Mjax in manual.

  1. No I didn't do that.

@dae
Copy link
Member

dae commented Jun 3, 2025

Re do-one-thing, I try to be pragmatic here, as I know atomic commits are more work. But the more you pack into a PR, the more likely is to stall due to an issue with one part, or the time required to review it, so I'd recommend limiting yourself to a few pages at a time in the future.

When I wrote ankitects/anki-manual#275, I wasn't aware of the redirect trick Danika discovered - would definitely recommend using that.

For 3, as long as existing links don't break, the loss of the TOC entries doesn't worry me too much - I don't think many people are reading through the list when they have issues. If you and Danika are satisfied we haven't lost anything important in 2, LGTM.

@brishtibheja
Copy link
Contributor Author

When I wrote ankitects/anki-manual#275, I wasn't aware of the redirect trick Danika discovered - would definitely recommend using that.

I have mentioned this one before (ankitects/anki-manual#386 (comment)) but it can only be used within the same book so not very useful here. Or there's some trick I'm not aware of?

@dae
Copy link
Member

dae commented Jun 4, 2025

If I've misattributed the original person to mention this, my apologies. But the docs say that any http(s) link can be used as the target, so we should be able to link to a different book?

@brishtibheja
Copy link
Contributor Author

Ah, sorry, didn't notice that. So, we should do that instead of emptying the page?

The value can be any valid URI the browser should navigate to (e.g. https://rust-lang.org/, /overview.html, or ../bibliography.html).

@dae
Copy link
Member

dae commented Jun 4, 2025

Saves the user and extra click/read, so it seems preferable to almost-blank 'see here instead' pages.

@brishtibheja brishtibheja marked this pull request as ready for review June 6, 2025 13:29
@Danika-Dakika
Copy link
Collaborator

@brishtibheja
The only change you added was the redirects in book.toml .

This was done as part of this issue ...

  1. Thank you, that's exactly the kind of thing I'm looking for. That issue addresses only 2 of the pages you're proposing to delete -- so you've got 4 more to go.

FYI the pages I emptied out in this PR all had their info migrated to manual as part of the above linked issue.
...
I didn't compare but you might find this issue relevant ...

  1. Other than the 2 pages I mentioned above, I don't see that.

There is still quite a bit being stricken here that has not been added anywhere else. If it's not worth it to you to review each of these more carefully and account for what you're proposing to delete, then it's not worth it for Damien or I to do that for you.

And I don't understand the relevance of that link to PR 306. That also didn't add anything to the manual that you're deleting here.

  1. It looks like those redirects in book.toml will work for those 5 files, but that means the pages can be completely deleted. See https://github.com/ankitects/anki-manual?tab=readme-ov-file#removing-a-page for the steps on how to remove the pages properly.

  2. For the 6th edit [to the v3 scheduler page], you're only removing part of the page, so I'm not sure the message you're replacing it with makes sense ("The contents of this page ..."). But I'm also concerned that this particular FAQ should stay as-is, because it memorializes changes from a lot of areas that all came with v3. When you explain your reasoning (at Update when-anki-does-not-start-on-windows-debugging-steps.md #1), perhaps you can address that too.

@Danika-Dakika Danika-Dakika marked this pull request as draft June 13, 2025 21:04
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.

3 participants