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

docs: revise intro page #342

Merged
merged 3 commits into from
Apr 17, 2024
Merged

docs: revise intro page #342

merged 3 commits into from
Apr 17, 2024

Conversation

m1ghtym0
Copy link
Member

Just some small adjustments. I will at a concept graphic once this is ready.

@m1ghtym0 m1ghtym0 requested a review from katexochen as a code owner April 17, 2024 09:42
@m1ghtym0 m1ghtym0 added the documentation Improvements for user docs label Apr 17, 2024
Copy link

github-actions bot commented Apr 17, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-04-17 15:24 UTC


## Next steps

You can learn more about the concept of Confidential Containers, features, security benefits, and performance of Constellation in the *Basics* section. To jump right into the action head to *Getting started*.
Copy link
Member

Choose a reason for hiding this comment

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

Should Basics and Getting started be links?

Copy link
Member Author

Choose a reason for hiding this comment

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

The problem is that we can't link to a section if's not a dedicated page.
Maybe I missing something though?

Copy link
Member

Choose a reason for hiding this comment

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

Indeed, this seems to be an open issue: facebook/docusaurus#6041

There seems to be an acceptable workaround that would also allow us to write some text to the category page (something I'd like to do anyway): facebook/docusaurus#7975 (comment)

But nothing to implement in this PR.

Copy link
Member

Choose a reason for hiding this comment

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

If I understand the docs right, this is an even simpler solution: https://docusaurus.io/docs/sidebar/items#embedding-generated-index-in-doc-page

@katexochen katexochen added no changelog PRs not listed in the release notes and removed documentation Improvements for user docs labels Apr 17, 2024
@katexochen katexochen reopened this Apr 17, 2024
@katexochen
Copy link
Member

Oops, unintended use of fixes keyword, sorry.

@m1ghtym0 m1ghtym0 merged commit 8820673 into main Apr 17, 2024
6 checks passed
@m1ghtym0 m1ghtym0 deleted the m/docs/intro branch April 17, 2024 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changelog PRs not listed in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants