-
-
Notifications
You must be signed in to change notification settings - Fork 617
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
Added reference pages to docs #1594
Conversation
05c5cff
to
e4ea089
Compare
Yes. Every library should have its own category. There should also be a category for…I've never come up with a good name for these…the project APIs? Meaning things like
No, please remove these if you can.
No, that is intended to be part of the introductory guide. |
If it's easier, we can go ahead and land this PR and then clean up and reorganize in a follow-up. |
Let me remove all empty generated documents and Removing Values first. I just didn't have much time for this in the weekend. Then I can leave making categories to you in another commit. |
All pages with "This document was generated [...]" have been removed. Here is a list with all removed files (75 files in total):
Note: some functions mentioned in pages above look useful. Maybe consider making some sort of todo-list for them if you want to document them in the future. I consider this PR as done for now. Ready to merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I'll follow up with a new request for the user guide pages, and I'll fill in the sidebar while I'm at it. And I'll capture that list of autogenerated pages to see what's useful to document.
In case it's helpful, I also added a to-do list to #1547 with what I think still remains.
What does this commit add
[text](Page)
to[text](Page.md)
.sidebars.js
in alphabetical order. Currently there are 5 subcategories: os, path, premake, string, table.Live demo here: https://kyriets.github.io/premake-core/docs/
Things to consider before merge
Wiki pages that were NOT migrated
I suppose @starkos is already in a process of migrating them :-)
FYI: I did not include any malicious or additional text into the docs I migrated.
#1547