Skip to content

Commit

Permalink
correct un-needed escape
Browse files Browse the repository at this point in the history
Also fix typecheck
  • Loading branch information
adriantam committed Dec 1, 2023
1 parent 4e9e4e1 commit fd311ef
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 6 deletions.
10 changes: 5 additions & 5 deletions docs/content/modeling/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@ Why? This relation definition states:
- That organizations have members
- That the members of an organization with id \{id\} are all users described by tuples of the form:

`{ user: {user-id}, relation: "member", object: "organization:\{id\}" }`
`{ user: {user-id}, relation: "member", object: "organization:{id}" }`

:::info Important
Relation definitions of the form “define \{relation\}: [user, organization#member]" are fairly common. They are used to express that relationships "to the object with that relation" (e.g. "users" of type user or "member of organization") can be assigned by your system and that only the users that have that relation are those with a [direct relationship](./building-blocks/direct-relationships.mdx).
Expand Down Expand Up @@ -705,7 +705,7 @@ Why? This <ProductConcept section="what-is-a-relation" linkName="relation defini

- each document can have one or more owners
- owners of a document are assignable by creating a tuple of the format
`{ user: "{user_id}", relation: "owner", object: "document:\{id\}" }` for individual users
`{ user: "{user_id}", relation: "owner", object: "document:{id}" }` for individual users

##### Relation: Editor

Expand Down Expand Up @@ -740,7 +740,7 @@ Why? This relation definition states that:

- each document can have editors
- the editor(s) of a document are assignable by creating a tuple with shape
`{ user: "{user_id}", relation: "editor", object: "document:\{id\}" }` for individual users
`{ user: "{user_id}", relation: "editor", object: "document:{id}" }` for individual users

This also supports making all members in an organization editors of the document, through a [group to object relationship](./user-groups.mdx). A relationship tuple like the following one states that the members of organization A are editors of document 0001.

Expand Down Expand Up @@ -814,8 +814,8 @@ Why? This relation definition states that:

- documents may have a parent
- the parent(s) of a document with id \{id\} is either a folder or a drive, described by one of these relationship tuples:
- `{ user: "folder:\{id\}", relation: "parent", object: "document:\{id\}" }`
- `{ user: "drive:\{id\}", relation: "parent", object: "document:\{id\}" }`
- `{ user: "folder:{id}", relation: "parent", object: "document:{id}" }`
- `{ user: "drive:{id}", relation: "parent", object: "document:{id}" }`


We can use [direct type restriction](../configuration-language.mdx#the-direct-relationship-type-restrictions) to ensure a document's parent can only be an object of type either drive or folder.
Expand Down
1 change: 1 addition & 0 deletions src/components/ButtonLink/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ type ButtonLinkProps = {
href?: string;
variant?: string;
icon?: React.ReactNode;
children?: React.ReactNode;
};

const ButtonLink: React.FC<ButtonLinkProps> = ({ to, href, variant = 'default', icon, children }) => {
Expand Down
1 change: 1 addition & 0 deletions src/components/Docs/CardBox/CardBox.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ export type CardBoxProps = {
shouldBold?: boolean;
shouldShowArrowOnHover?: boolean;
};
children?: React.ReactNode;
};

const CardBox: React.FC<CardBoxProps> = (props) => {
Expand Down
2 changes: 1 addition & 1 deletion src/components/Docs/ProductName/ProductName.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export function ProductName(opts: ProductNameOpts): JSX.Element {
((siteConfig.customFields.introLink as string) + siteConfig.customFields.productDescriptionSection)) as string;
switch (opts.format) {
case ProductNameFormat.ProductLink:
return <a href={productLink}>{siteConfig.customFields.productName}</a>;
return <a href={productLink}>{siteConfig.customFields.productName as string}</a>;
case ProductNameFormat.LongForm:
return <>{siteConfig.customFields.longProductName}</>;
case ProductNameFormat.ShortForm:
Expand Down
1 change: 1 addition & 0 deletions src/components/Section/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import styles from './Section.module.css';
type SectionProps = {
id: string;
className?: string;
children?: React.ReactNode;
};

const Section: React.FC<SectionProps> = ({ id, children, className }) => {
Expand Down

0 comments on commit fd311ef

Please sign in to comment.