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.

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

CLIENT-SPECIFICATION: add automatic platform detection suggestion, fix Markdown syntax #11523

Merged
merged 12 commits into from
Nov 30, 2023
Merged

CLIENT-SPECIFICATION: add automatic platform detection suggestion, fix Markdown syntax #11523

merged 12 commits into from
Nov 30, 2023

Conversation

kbdharun
Copy link
Member

Changes

  • Update/Fix Markdown Syntax throughout the page to fix markdown-lint errors.
  • Add @pixelcmtd's suggestion to automatically detect new platforms from the pages directory.

@kbdharun
CLIENT-SPECIFICATION: add platform suggestion
62b74a9 
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
@kbdharun kbdharun added this to the v2.1 milestone Nov 16, 2023
@github-actions github-actions bot added the documentation Issues/PRs modifying the documentation. label Nov 16, 2023
@kbdharun kbdharun mentioned this pull request Nov 16, 2023
Closed
70 tasks
acuteenvy
acuteenvy reviewed Nov 16, 2023
View reviewed changes
Copy link
Member

@acuteenvy acuteenvy left a comment

Choose a reason for hiding this comment

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

list it as a supported platform in --platform option

Where do you think it should be listed?

CLIENT-SPECIFICATION.md Outdated Show resolved Hide resolved
acuteenvy
acuteenvy approved these changes Nov 17, 2023
View reviewed changes
CLIENT-SPECIFICATION.md Outdated Show resolved Hide resolved
@kbdharun @acuteenvy
CLIENT-SPECIFICATION: minor fixes
64c1d13 
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
@acuteenvy
Copy link
Member

Since you merged #10730, we should probably bump the version.

@kbdharun
Copy link
Member Author

kbdharun commented Nov 17, 2023 •
edited
Loading

Since you merged #10730, we should probably bump the version.

Agreed, I am planning to include this suggestion too (for this one we don't need to wait as long as previous PR as this isn't a required change) in the 2.1 version.

Btw, Version bump is only necessary when we update the changelog will do it next week. Until then I will keep this PR open for review.

kbdharun
kbdharun commented Nov 24, 2023
View reviewed changes
CLIENT-SPECIFICATION.md Outdated Show resolved Hide resolved
sbrl
sbrl requested changes Nov 28, 2023
View reviewed changes
Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Just got a couple of comments on this - looks like a good update to the spec!

Can't believe that the spec I wrote some time ago is still alive and kicking lol :P

CLIENT-SPECIFICATION.md Outdated Show resolved Hide resolved
CLIENT-SPECIFICATION.md Outdated Show resolved Hide resolved
CLIENT-SPECIFICATION.md
- [v1.0, January 23rd 2019](https://github.com/tldr-pages/tldr/blob/v1.0/CLIENT-SPECIFICATION.md) (deprecated) ([#2706](https://github.com/tldr-pages/tldr/pull/2706))
- Initial release.

- Unreleased
Copy link
Member

Choose a reason for hiding this comment

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

Changelog will need updating before this is merged.

Copy link
Member Author

@kbdharun kbdharun Nov 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Agreed, will update the changelog and will merge this PR tomorrow (will prepare the release notes too).

Copy link
Member Author

@kbdharun kbdharun Nov 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Done, updated the changelog. Now, I will work on the release notes (which would be pretty small for this release) and then the new release is GTG.

@kbdharun @sbrl
CLIENT-SPECIFICATION: update page
9dde7a3 
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
@kbdharun
Copy link
Member Author

Can't believe that the spec I wrote some time ago is still alive and kicking lol :P

Yeah, that's some incredible work you did ❤️ publishing the initial spec and maintaining it throughout time. I am still fascinated by the professional wording and references to RFCs, etc in our client specification.

@kbdharun kbdharun requested a review from sbrl November 29, 2023 14:42
sbrl
sbrl reviewed Nov 29, 2023
View reviewed changes
CLIENT-SPECIFICATION.md Outdated Show resolved Hide resolved
@kbdharun @sbrl
CLIENT-SPECIFICATION: minor fixes
10b37c1 
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
sbrl
sbrl approved these changes Nov 29, 2023
View reviewed changes
Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Cool!

sebastiaanspeck
sebastiaanspeck requested changes Nov 30, 2023
View reviewed changes
CLIENT-SPECIFICATION.md Outdated Show resolved Hide resolved
@kbdharun @sebastiaanspeck
Update CLIENT-SPECIFICATION.md
5b49255 
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
@kbdharun kbdharun self-assigned this Nov 30, 2023
@kbdharun kbdharun closed this Nov 30, 2023
@kbdharun kbdharun reopened this Nov 30, 2023
@kbdharun
CLIENT-SPECIFICATION: update changelog
d14c48b 
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
acuteenvy
acuteenvy reviewed Nov 30, 2023
View reviewed changes
CLIENT-SPECIFICATION.md Outdated Show resolved Hide resolved
@kbdharun @acuteenvy
CLIENT-SPECIFICATION: fix description in changelog
c4bfcce 
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
@kbdharun kbdharun merged commit 862f4c9 into main Nov 30, 2023
8 checks passed
@kbdharun kbdharun deleted the cleanup/client-spec branch November 30, 2023 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@acuteenvy acuteenvy acuteenvy approved these changes

@sbrl sbrl sbrl approved these changes

@sebastiaanspeck sebastiaanspeck sebastiaanspeck approved these changes

@SethFalco SethFalco Awaiting requested review from SethFalco

Assignees

@kbdharun kbdharun

Labels
documentation Issues/PRs modifying the documentation.
Projects
None yet
Milestone
v2.1
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@kbdharun @acuteenvy @sbrl @sebastiaanspeck