Skip to content

Commit

Permalink
docs: remove technical documentation label and update readme (#2814)
Browse files Browse the repository at this point in the history
Co-authored-by: Kyrylo Hudym-Levkovych <[email protected]>
  • Loading branch information
khudym and Kyrylo Hudym-Levkovych authored Nov 16, 2023
1 parent cfd1209 commit 38017c1
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 14 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ Documentation lives at https://paragon-openedx.netlify.app/.

## Getting Started

### Getting Help

Please reach out to the Paragon Working Group (PWG):

* Open edX Slack ([request an invite](https://openedx.org/slack)): [#wg-paragon](https://openedx.slack.com/archives/C02NR285KV4)
* [Github Issues](https://github.com/openedx/paragon/issues/new?template=blank-issue.md)
* [Weekly PWG Meeting](https://calendar.google.com/calendar/embed?src=c_v86shrnegshsqgp4fj2k94u7bc%40group.calendar.google.com&ctz=America%2FNew_York)

### React Components

Paragon components require React 16 or higher. To install Paragon into your project:
Expand Down Expand Up @@ -65,14 +73,6 @@ The Paragon CLI (Command Line Interface) is a tool that provides various utility

Use `paragon help` to see more information.

## Getting Help

Please reach out to the Paragon Working Group (PWG):

* Open edX Slack ([request an invite](https://openedx.org/slack)): [#wg-paragon](https://openedx.slack.com/archives/C02NR285KV4)
* [Github Issues](https://github.com/openedx/paragon/issues/new?template=blank-issue.md)
* [Weekly PWG Meeting](https://calendar.google.com/calendar/embed?src=c_v86shrnegshsqgp4fj2k94u7bc%40group.calendar.google.com&ctz=America%2FNew_York)

## Internationalization

Paragon supports internationalization for its components out of the box with the support of [react-intl](https://formatjs.io/docs/react-intl/). You may view translated strings for each component on the documentation website by switching languages in the settings.
Expand Down
3 changes: 0 additions & 3 deletions www/src/components/header/SiteTitle.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@ export default function SiteTitle({ title, isFullVersion, className } : SiteTitl
{isFullVersion && (
<div className="ml-3 mr-3">
<h1 className="pgn-doc__header-title-heading h4">{title}</h1>
<p className="pgn-doc__header-title-description x-small">
Technical Documentation
</p>
</div>
)}
</div>
Expand Down
3 changes: 0 additions & 3 deletions www/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ function HomePage() {
{/* eslint-disable-next-line react/jsx-pascal-case */}
<SEO title="Home" />
<div className="bg-dark text-white text-center py-5">
<p className="x-small text-uppercase text-monospace mb-0">
Technical Documentation{' '}
</p>
<h1 className="display-3 text-white">Paragon Design System</h1>
<p className="lead mx-auto my-3 mb-4" style={{ maxWidth: '28em' }}>
An accessible, theme-ready, and open source design system built for
Expand Down

0 comments on commit 38017c1

Please sign in to comment.