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

Instructions for building documentation missing #40

Open
nylnx opened this issue Dec 18, 2024 · 3 comments
Open

Instructions for building documentation missing #40

nylnx opened this issue Dec 18, 2024 · 3 comments
Assignees

Comments

@nylnx
Copy link

nylnx commented Dec 18, 2024

I'm missing instructions on building a documentation HTML or PDF. I see a Jenkinsfile, which hints at a hugo setup, but no obvious instructions how to use it.

Maybe the documentation can also be built as a Github Release and published that way.

@nylnx
Copy link
Author

nylnx commented Dec 18, 2024

Just seen #35. Seems like there is work going on to make it happen.

I hope this happens soon :)

@fdesbiens
Copy link
Contributor

Hi @nylnx.

Yes, I am converting the documentation to AsciiDoc right now. Once it is converted, you will be able to publish it in any format supported by the AsciiDoctor tool.

We will make the HTML and PDF versions available on threadx.io.

This particular repository will likely be put in read-only mode once the conversion is done, since we will not accept changes to the old MD files in the future.

@fdesbiens fdesbiens self-assigned this Dec 18, 2024
@nylnx
Copy link
Author

nylnx commented Dec 18, 2024

That sounds awesome! It's good to see ThreadX picking up pace again.

Please also consider my other issue #39 about version compatibility. This is also something that I would expect from a documentation page.

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