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

Build instructions should read "# or" #295

Open
alandefreitas opened this issue Aug 13, 2024 · 1 comment
Open

Build instructions should read "# or" #295

alandefreitas opened this issue Aug 13, 2024 · 1 comment

Comments

@alandefreitas
Copy link
Member

@alandefreitas , your reply was detailed, and at the moment I am not following the thread. Which leads through mrdocs, antora, command-line options, and so on. That's ok. How about this:

Pull request 283 only fixes the macOS issue (which I believe it does.) Done.
In another PR, when you have a chance, you could update the README. Considering these points:

  • "We need your # or comment."
  • The README mentions multiple output dirs. Open file:///home/user/path/to/antora/build/develop/doc and Open file:///home/user/path/to/antora/build/doc. If switching to or it would only be one directory?
  • A suggestion that the output location is described this way. (not required).
/home/user/website-v2-docs/build

or

/home/user/website-v2-docs/build (or wherever you have checked out the repository) 
  • anything else

Originally posted by @sdarwin in #283 (comment)

@sdarwin
Copy link
Collaborator

sdarwin commented Aug 13, 2024

or,

the current README might be showing actual script output:

Site generation complete!
Open file:///home/user/path

However, if that is 'computed', the README is not able to 'compute' so it could explain the results in a different way, with this sort of text.

After running sitedoc.sh, the generated files will be found in the build/ directory. Open build/index.html in a browser.

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