Skip to content

Title typo of the installation.md in developer_docs directory #1344

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

Closed
min-kim42 opened this issue Mar 26, 2020 · 2 comments
Closed

Title typo of the installation.md in developer_docs directory #1344

min-kim42 opened this issue Mar 26, 2020 · 2 comments

Comments

@min-kim42
Copy link
Contributor

Nature of issue?

  • Found a bug

Details about the bug:

Spotted the title typo of the installation.md in developer_docs directory

  • Web browser and version: Version 80.0.3987.132
  • Operating System: MacOS Catalina Ver 10.15.3
  • Steps to reproduce this bug:
    See the first line of the installation.md in developer_docs directory. Link

Feature enhancement details:

Simply remove 'Development' on the first line of the document.
'Development Installation' → 'Installation'

New feature details:

@andrewn
Copy link
Member

andrewn commented Mar 27, 2020

Thanks for opening this issue, but I'm not sure this is a typo. Having "Development Installation" in the title makes it clear that the instructions relate to installing a development environment.

I'm going to close, but reopen if you think the title could be better or is unclear.

@andrewn andrewn closed this as completed Mar 27, 2020
@min-kim42
Copy link
Contributor Author

@andrewn Andrew, thanks for handling it. I thought it was a typo, because there are some inconsistencies. The file name is installation.md, not development_installation.md. If you take a look at all the other files in the developer_docs directory, the first line of each file is same as its file name. Your explanation also makes sense, but I found it confusing while translating docs into Korean. I think this might also confuse other translators in the future, but I do not think this is an urgent issue, thus I will leave it there.

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 a pull request may close this issue.

2 participants