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

Generate other wikis #769

Merged
merged 12 commits into from
Oct 31, 2022
Merged

Generate other wikis #769

merged 12 commits into from
Oct 31, 2022

Conversation

xsebek
Copy link
Member

@xsebek xsebek commented Oct 21, 2022

@xsebek xsebek changed the title WIP: Generate other wikis Generate other wikis Oct 30, 2022
@xsebek xsebek marked this pull request as ready for review October 30, 2022 00:08
@xsebek xsebek requested a review from byorgey October 30, 2022 00:08
@byorgey
Copy link
Member

byorgey commented Oct 30, 2022

Links on the new recipes and capabilities pages seem to be broken, they are missing /wiki/.

EDIT: perhaps we should just use arguments like --entities-page='Entities-cheat-sheet' instead of --entities-page='../Entities-cheat-sheet'?

Copy link
Member

@byorgey byorgey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't plan to read every line of code carefully. 😄 But the generated wiki pages look good (other than the broken links, which I suspect is not a problem with the code but rather with the flags passed on the command line).

@xsebek
Copy link
Member Author

xsebek commented Oct 30, 2022

@byorgey I am passing --entities-page='../Entities-cheat-sheet' because it is the relative address on our Wiki.

But if we or someone else wants to use it outside the Wiki then absolute links will be necessary.


I will check why the links are broken, I must have made some silly mistake. 😅

@xsebek
Copy link
Member Author

xsebek commented Oct 31, 2022

OK, so what confused me is that relative links work in the Wiki editor preview but then not on the page once saved.

I fixed it by using absolute links. 🙂

@xsebek xsebek added the merge me Trigger the merge process of the Pull request. label Oct 31, 2022
@mergify mergify bot merged commit 451e2ed into main Oct 31, 2022
@mergify mergify bot deleted the docgen-wikis branch October 31, 2022 17:04
@byorgey
Copy link
Member

byorgey commented Oct 31, 2022

Would it not work to just say e.g. --commands-page='Commands-Cheat-Sheet' ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge me Trigger the merge process of the Pull request.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create command line tools to automate documentation
2 participants