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

Update README.md #2425

Merged
merged 5 commits into from
Feb 21, 2022
Merged

Conversation

wolkenschieber
Copy link
Contributor

@wolkenschieber wolkenschieber commented Feb 20, 2022

Corrected Customizing IMAP Folders link

Description

This pull request fixes a typo in the Customizing IMAP Folders link.

Type of change

  • Readme update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (README.md or the documentation under docs/)
  • If necessary I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Corrected _Customizing IMAP Folders_ link
@casperklein
Copy link
Member

Good finding, thank you. I think that was a typo while creating the directory structure. Instead of adjusting the link, we should rename the uses-cases directory to use-cases.

@polarathene @wernerfred Whats your take on this?

@wernerfred
Copy link
Member

@polarathene @wernerfred Whats your take on this?

This:

Instead of adjusting the link, we should rename the uses-cases directory to use-cases.

@casperklein
Copy link
Member

@wernerfred Do you know of an easy way to check for dead internal links in our documentation?

@wernerfred
Copy link
Member

@wernerfred Do you know of an easy way to check for dead internal links in our documentation?

sadly not, i think @polarathene mentioned that he wanted to build something like this for CI last year but had no time to implement it yet IIRC

@polarathene
Copy link
Member

Do you know of an easy way to check for dead internal links in our documentation?

Yes it's on my backlog, my broken PC disk should have notes regarding it once I restore it later this week.

I think I was going to use a rust project lychee with the CI. We need to test markdown local links are valid (building docs with --strict mostly does that at least for file paths, but fails against validating anchor tags #), and also testing links on built docs.

Anyway, it'll get addressed eventually unless someone beats me to it 😅

@polarathene
Copy link
Member

Also agree on changing the docs file name instead.

It won't affect previous docs which are versioned (which also retain typos/bugs). We may at a later point want to consider rebuilding old tags with newer version of the docs generator, but it may not be worth it either (there was some deprecations a while back, one with admonition support I think and recently the mermaid one).

casperklein
casperklein previously approved these changes Feb 21, 2022
@georglauterbach
Copy link
Member

I will merge this after #2420

@github-actions
Copy link
Contributor

Documentation preview for this PR is ready! 🎉

Built with commit: cca0f77

@georglauterbach georglauterbach merged commit d858669 into docker-mailserver:master Feb 21, 2022
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.

None yet

5 participants