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

Added reference pages to docs #1594

Merged
merged 3 commits into from
Mar 16, 2021
Merged

Conversation

KyrietS
Copy link
Member

@KyrietS KyrietS commented Mar 12, 2021

What does this commit add

  • Added all reference pages (362 in total).
  • Every link has been changed from [text](Page) to [text](Page.md).
  • Added all reference pages to 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

  • More subcategories? Possible candidates are: buffered, criteria, http, io, json, term, zip
  • Should we leave auto-generated documents like criteria._compile.md for now? There are more pages like this.
  • Should Removing Values be in the reference category? It looks like an api reference to me.

Wiki pages that were NOT migrated

About-This-Wiki.md
Adding-a-new-Action.md
Adding-Source-Files.md
Adding-Unit-Tests.md
Build-Settings.md
Building-Premake.md
Code-Overview.md
Coding-Conventions.md
Command-Line-Arguments.md
Configurations-and-Platforms.md
Contribution-Guidelines.md
Custom-Build-Commands.md
Custom-Rules.md
Debugging-Scripts.md
Developing-Modules.md
Development-Roadmap.md
Embedding-Modules.md
Extending-Premake.md
Feature-Matrix.md
Filters.md
Generating-Project-Files.md
Getting-Help.md
Getting-Premake.md
Home.md
How-To-Help.md
Linking.md
Locating-Scripts.md
Lua-Library-Additions.md
Lua-Library-Additions.updated
Makefile-Projects.md
Migrating-From-4.x.md
Migrating-From-BitBucket.md
Modules-Proposal.md
Modules.md
Overrides-and-Call-Arrays.md
Precompiled-Headers.md
Project-API.md
Scopes-and-Inheritance.md
Sharing-Configuration-Settings.md
Sharing-Your-Module.md
Starting-Your-New-Action.md
System-Scripts.md
Tokens.md
Topics.md
Tutorial
Tutorial-Premake-example-with-GLFW-and-OpenGL.md
Tutorials.md
Usages.md
Using-Modules.md
Using-Premake.md
What's-New-in-5.0.md
What-Is-Premake.md
Who-Uses-Premake.md
Why-Do-Call-Arrays-Need-Functions.md
Workspaces-and-Projects.md
Your-First-Script.md

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

@KyrietS KyrietS force-pushed the api-reference-pages branch from 05c5cff to e4ea089 Compare March 12, 2021 21:10
@starkos
Copy link
Member

starkos commented Mar 13, 2021

More subcategories? Possible candidates are: buffered, criteria, http, io, json, term, zip

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 defines() and includedirs() which you use to specify project configuration. People need a place to see all of the available configuration settings that are supported, without the clutter of the other libraries.

Should we leave auto-generated documents like criteria._compile.md for now?

No, please remove these if you can.

Should Removing Values be in the reference category?

No, that is intended to be part of the introductory guide.

@starkos
Copy link
Member

starkos commented Mar 15, 2021

If it's easier, we can go ahead and land this PR and then clean up and reorganize in a follow-up.

@KyrietS
Copy link
Member Author

KyrietS commented Mar 16, 2021

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.

@KyrietS
Copy link
Member Author

KyrietS commented Mar 16, 2021

All pages with "This document was generated [...]" have been removed. Here is a list with all removed files (75 files in total):

buffered.close
buffered.new
buffered.tostring
buffered.write
buffered.writeln
criteria._compile
criteria._delete
criteria._word
criteria.allowPrefix
criteria.flatten
criteria.matches
criteria.new
http.escapeUrlParam
http.reportProgress
json.encode_pretty
os._is64bit
os.compile
os.getSystemTags
os.getWindowsRegistry
os.ishost
os.istarget
os.match
os.matchdone
os.matchisfile
os.matchname
os.matchnext
os.matchstart
os.translateCommandsAndPaths
package.loadlib
package.searchpath
path.isasmfile
path.isidlfile
path.isnativefile
path.isobjcfile
path.isobjcppfile
premake.alias
premake.callArray
premake.capture
premake.captured
premake.checkVersion
premake.clearWarnings
premake.downloadModule
premake.eol
premake.error
premake.esc
premake.escaper
premake.filename
premake.findProjectScript
premake.generate
premake.indent
premake.info
premake.isSemVer
premake.out
premake.outln
premake.override
premake.pop
premake.push
premake.quoted
premake.resolveAlias
premake.showhelp
premake.touch
premake.utf8
premake.w
premake.warn
premake.warnOnce
premake.x
premake.xmlUtf8
table.difference
table.equals
table.filter
table.insertkeyed
table.insertsorted
table.intersect
table.shallowcopy
table.unique

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.

Copy link
Member

@starkos starkos left a 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.

@starkos starkos merged commit c97edfa into premake:master Mar 16, 2021
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

Successfully merging this pull request may close these issues.

2 participants