Skip to content

docs: about #673

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

Merged
merged 25 commits into from
Mar 31, 2022
Merged

docs: about #673

merged 25 commits into from
Mar 31, 2022

Conversation

Shinigami92
Copy link
Member

@Shinigami92 Shinigami92 commented Mar 25, 2022

This PR is based on #658, so please merge that one first (done ✔️)

@Shinigami92 Shinigami92 added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Mar 25, 2022
@Shinigami92 Shinigami92 self-assigned this Mar 25, 2022
@Shinigami92 Shinigami92 linked an issue Mar 25, 2022 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Mar 25, 2022

Codecov Report

Merging #673 (f1fee9a) into main (0304120) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #673   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files        1924     1924           
  Lines      177010   177010           
  Branches      908      908           
=======================================
  Hits       175858   175858           
  Misses       1096     1096           
  Partials       56       56           

@ST-DDT
Copy link
Member

ST-DDT commented Mar 25, 2022

This PRs title is misleading

@Shinigami92 Shinigami92 changed the title docs: convert to typescript docs: about Mar 25, 2022
Copy link
Member

@ST-DDT ST-DDT left a comment

Choose a reason for hiding this comment

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

Don't forget the redirect for update

@ejcheng ejcheng added the s: on hold Blocked by something or frozen to avoid conflicts label Mar 25, 2022
@ST-DDT
Copy link
Member

ST-DDT commented Mar 25, 2022

TODO for later: Consider adding SSR for team/api-docs to serve only static pages.

@ejcheng ejcheng added do NOT merge yet Do not merge this PR into the target branch yet and removed s: on hold Blocked by something or frozen to avoid conflicts labels Mar 25, 2022
@Shinigami92
Copy link
Member Author

TODO for later: Consider adding SSR for team/api-docs to serve only static pages.

We found out that VitePress already does successfully SSG for the about section, but the API section seems not to work correctly 🤔
But this is not part for this PR

Base automatically changed from docs-convert-to-typescript to main March 25, 2022 15:38
@Shinigami92 Shinigami92 removed the do NOT merge yet Do not merge this PR into the target branch yet label Mar 25, 2022
ejcheng
ejcheng previously approved these changes Mar 26, 2022
Copy link
Member

@ejcheng ejcheng left a comment

Choose a reason for hiding this comment

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

LGTM, thank you! :)

ejcheng
ejcheng previously approved these changes Mar 27, 2022
pkuczynski
pkuczynski previously approved these changes Mar 28, 2022
ST-DDT
ST-DDT previously approved these changes Mar 28, 2022
Copy link
Member

@ST-DDT ST-DDT left a comment

Choose a reason for hiding this comment

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

IMO clicking on about should already redirect the user, unfortunately vitepress doesn't support this or I don't know how.
Also the announcement page is quite empty. Maybe we can add some more pseudo content here. Or even a v6 release anouncement.

@Shinigami92
Copy link
Member Author

IMO clicking on about should already redirect the user, unfortunately vitepress doesn't support this or I don't know how.
Also the announcement page is quite empty. Maybe we can add some more pseudo content here. Or even a v6 release announcement.

Yeah, I hope that this page will be filled in the future with some more content. Right now it's just the start and that is one reason why it's so empty.

I would like to leave this to @JessicaSachs

ejcheng
ejcheng previously approved these changes Mar 28, 2022
prisis
prisis previously approved these changes Mar 31, 2022
@Shinigami92 Shinigami92 dismissed stale reviews from prisis, ejcheng, ST-DDT, and pkuczynski via af0f6cf March 31, 2022 11:31
@ST-DDT ST-DDT added the s: accepted Accepted feature / Confirmed bug label Mar 31, 2022
@ST-DDT ST-DDT enabled auto-merge (squash) March 31, 2022 18:25
@ST-DDT ST-DDT merged commit 48dcec1 into main Mar 31, 2022
@Shinigami92 Shinigami92 deleted the docs-about branch March 31, 2022 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Improve Announcement Page / Add About section
6 participants