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

Add documentation page and banner to new users #113

Merged
merged 19 commits into from
Mar 20, 2024
Merged

Add documentation page and banner to new users #113

merged 19 commits into from
Mar 20, 2024

Conversation

ajhenry
Copy link
Collaborator

@ajhenry ajhenry commented Mar 19, 2024

This adds a page for documentation that is rendered from a markdown file.

This also adds a new banned to the homepage that still needs some wording suggestions.

The routing for documentation will be updated in a follow-up PR.

import RepositoriesTable from './RepositoriesTable';

export const OrganizationSheet = () => {
const [showBanner, setShowBanner] = useLocalStorage('show-banner', false);
const isSSR = useSSR();
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We need to perform an SSR check here because next doesn't like when it doesn't have access to things that modify the initial hydration on the client. In this case -> rendering a banner when we finally have access to localStorage

Copy link
Collaborator

@ipc103 ipc103 left a comment

Choose a reason for hiding this comment

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

🚀 Looks great to me! I left a couple of suggestions for wording on the documentation, and my best suggestion for copy in the banner.

@@ -0,0 +1,7 @@
# Dangerously
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can this file be removed?

who-metrics-ui/src/hooks/useSSR.ts Outdated Show resolved Hide resolved
who-metrics-ui/src/components/OrganizationSheet.tsx Outdated Show resolved Hide resolved
who-metrics-ui/docs/definitions.md Outdated Show resolved Hide resolved
who-metrics-ui/docs/definitions.md Outdated Show resolved Hide resolved
who-metrics-ui/docs/definitions.md Outdated Show resolved Hide resolved
who-metrics-ui/docs/definitions.md Outdated Show resolved Hide resolved
@ajhenry ajhenry merged commit 5479bd5 into main Mar 20, 2024
5 checks passed
@ajhenry ajhenry deleted the docs branch March 20, 2024 19:59
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.

3 participants