Skip to content

scdoc: add page #19604

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

scdoc: add page #19604

wants to merge 14 commits into from
+12 −0

Conversation

@anhkhoakz
Copy link

@anhkhoakz anhkhoakz commented Nov 25, 2025

Checklist

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR contains at most 5 new pages.
  • The PR is authored by me, or has been human-reviewed if it was created with AI or machine translation software.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known): 1.11.4
  • Reference issue: #

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Nov 25, 2025
@CLAassistant
Copy link

CLAassistant commented Nov 25, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@Managor Managor changed the title initial add scdoc scdoc: add page Nov 25, 2025
@Managor
Copy link
Member

Managor commented Nov 25, 2025

Sign the CLA or we won't be able to merge this.

@anhkhoakz
Copy link
Author

anhkhoakz commented Nov 25, 2025

Sign the CLA or we won't be able to merge this.

I've signed it, thank you for your reminder.

Managor
Managor requested changes Nov 25, 2025
View reviewed changes
Managor
Managor reviewed Nov 25, 2025
View reviewed changes
Managor
Managor reviewed Nov 25, 2025
View reviewed changes
anhkhoakz and others added 3 commits November 25, 2025 16:31
@anhkhoakz @Managor
Update pages/common/scdoc.md
d8154db 
Co-authored-by: Managor <42655600+Managor@users.noreply.github.com>
@anhkhoakz @Managor
Update pages/common/scdoc.md
10c99f3 
Co-authored-by: Managor <42655600+Managor@users.noreply.github.com>
@anhkhoakz @Managor
Update pages/common/scdoc.md
57f3a95 
Co-authored-by: Managor <42655600+Managor@users.noreply.github.com>
Managor
Managor approved these changes Nov 25, 2025
View reviewed changes
Copy link
Member

@Managor Managor left a comment

Choose a reason for hiding this comment

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

Looks good after this.

@anhkhoakz @Managor
Update pages/common/scdoc.md
6934d7b 
Co-authored-by: Managor <42655600+Managor@users.noreply.github.com>
@anhkhoakz
Copy link
Author

anhkhoakz commented Nov 25, 2025

Yeah, I think it's good for now

ivanbaluta
ivanbaluta reviewed Nov 25, 2025
View reviewed changes
Managor
Managor reviewed Nov 25, 2025
View reviewed changes
anhkhoakz and others added 2 commits November 26, 2025 09:45
@anhkhoakz @Managor
Update pages/common/scdoc.md
75f6eb7 
Co-authored-by: Managor <42655600+Managor@users.noreply.github.com>
@anhkhoakz
Merge branch 'main' into add-scdoc
24613ce
ivanbaluta
ivanbaluta reviewed Nov 26, 2025
View reviewed changes
pages/common/scdoc.md

- Generate man pages from a scdoc file and display the generated troff (man) source:

`scdoc < file.scd | {{less}}`
Copy link
Collaborator

@ivanbaluta ivanbaluta Nov 26, 2025

Choose a reason for hiding this comment

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

Suggested change
`scdoc < file.scd | {{less}}`
`scdoc < {{path/to/file.scd}} | {{less}}`

Copy link
Member

@dmmqz dmmqz Nov 26, 2025

Choose a reason for hiding this comment

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

Could you apply this one as well @anhkhoakz?

anhkhoakz and others added 2 commits November 27, 2025 00:09
@anhkhoakz @ivanbaluta
Update pages/common/scdoc.md
a28fd7c 
Co-authored-by: Ivan Baluta <50071699+ivanbaluta@users.noreply.github.com>
@anhkhoakz
Merge branch 'main' into add-scdoc
4cbaad6
@anhkhoakz anhkhoakz requested a review from dmmqz November 26, 2025 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Managor Managor Managor approved these changes

@ivanbaluta ivanbaluta ivanbaluta approved these changes

@dmmqz dmmqz Awaiting requested review from dmmqz

Assignees

No one assigned

Labels

new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@anhkhoakz @CLAassistant @Managor @ivanbaluta @dmmqz