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

Re-structure common docs files into sub-folders. #2268

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

tritao
Copy link
Contributor

@tritao tritao commented Sep 28, 2024

As title says, just some re-organization to group common files into sub-folders.

@tritao tritao changed the title Re-organize docs structure into sub-folders. Re-structure common docs files into sub-folders. Sep 28, 2024
@tritao tritao marked this pull request as ready for review September 28, 2024 15:03
Comment on lines +323 to +341
'globals/_ACTION',
'globals/_ARGS',
'globals/_MAIN_SCRIPT_DIR',
'globals/_MAIN_SCRIPT',
'globals/_OPTIONS',
'globals/_OS',
'globals/_PREMAKE_COMMAND',
'globals/_PREMAKE_DIR',
'globals/_PREMAKE_VERSION',
'globals/_TARGET_ARCH',
'globals/_TARGET_OS',
'globals/_WORKING_DIR',
'globals/dofileopt',
'globals/iif',
'globals/include',
'globals/includeexternal',
'globals/printf',
'globals/require',
'globals/verbosef',
Copy link
Member

Choose a reason for hiding this comment

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

I believe you can replace the list of items with a single item:

{
  type: 'autogenerated',
  dirName: 'globals',
},

And it should expand to all of the files in the folder. See here under the "A real-world example" collapsed section.

@KyrietS I recall when you first introduced this doc system that we had discussed autogenerating the sidebar, was there a reason we didn't do this before? I vaguely recall that it might not have been available at the time, is that right?

@samsinsane
Copy link
Member

@tritao I'd like to give @KyrietS some time to provide feedback before I merge this.

@samsinsane samsinsane merged commit cda6493 into premake:master Oct 3, 2024
14 checks passed
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