Skip to content

README: Move info about building docs above platform-specific dependency info? #208

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

Open
rayrrr opened this issue May 29, 2021 · 1 comment

Comments

@rayrrr
Copy link

rayrrr commented May 29, 2021

Hi, can we move the info in the README under the heading "Getting Erlang documentation"
above the info about specific platform dependency installation, so that it is the first thing under the "Before asdf install" heading?

Given that it is embedded documentation, those steps must be performed before compilation (and should be encouraged) but I think one might assume that the platform-specific steps are the last thing to do and not scroll down to see it the embedded documentation info where it currently is.

Then the section that reads:

  1. KERL_BUILD_DOCS environment variable has to be set to value yes
  2. Additional dependencies have to be installed. For detailed list of dependencies for your OS please refer to the specific section above

could instead say "please refer to the specific section below."

Happy to furnish a PR if so. Thanks!

@Stratus3D
Copy link
Member

Hi @rayrrr , sorry for the late reply here! Hmm... I could see benefits to both orders. If we opted to move the section on Getting Erlang documentation up, we'd end up with the OS-specific dependency installation instructions at the very bottom of the readme, which seems a little backwards to me.

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

No branches or pull requests

2 participants