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

rfc 0005 analytics api #2690

Merged
merged 9 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions apps/engineering/app/docs/layout.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { source } from "@/app/source";
import { RootToggle } from "fumadocs-ui/components/layout/root-toggle";
import { DocsLayout } from "fumadocs-ui/layouts/docs";
import { Code, Component, Handshake, Terminal } from "lucide-react";
import { Code, Component, Terminal } from "lucide-react";

import type { ReactNode } from "react";
import { baseOptions } from "../layout.config";
Expand Down Expand Up @@ -39,10 +38,10 @@ export default function Layout({ children }: { children: ReactNode }) {
url: "/docs/architecture",
icon: <Component className="size-4 text-purple-600 dark:text-purple-400" />,
},
]
],
}}
>
{children}
</DocsLayout >
</DocsLayout>
);
}
21 changes: 9 additions & 12 deletions apps/engineering/app/rfcs/[[...slug]]/page.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { rfcSource } from "@/app/source";
import { Card } from "fumadocs-ui/components/card";
import defaultMdxComponents from "fumadocs-ui/mdx";
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from "fumadocs-ui/page";
import type { Metadata } from "next";
Expand All @@ -12,7 +11,6 @@ export default async function Page({
}: {
params: { slug?: string[] };
}) {

const page = rfcSource.getPage(params.slug);

if (!page) {
Expand All @@ -25,13 +23,11 @@ export default async function Page({
<div>
<h1 className="text-7xl md:text-8xl font-bold leading-none uppercase tracking-tight">
RFCS

</h1>
<p className="text-xl mt-8 font-light ">Check the sidebar</p>
</div>
</div>

)
);
}

const MDX = page.data.body;
Expand All @@ -40,19 +36,20 @@ export default async function Page({
<DocsPage toc={page.data.toc} full={page.data.full}>
<DocsTitle>{page.data.title}</DocsTitle>

<Card title="">
<div className="grid grid-cols-2 font-mono">
<span>ID</span>
<span>{page.data.title.split(" ").at(0)}</span>
<div className="flex flex-col gap-2">
<div className="flex justify-between items-center font-mono text-sm">
<span>{page.data.authors.length > 1 ? "Authors" : "Author"}</span>
<span>{page.data.authors.join(", ")}</span>
</div>

<div className="flex justify-between items-center font-mono text-sm">
<span>Date</span>
<LocalDate date={new Date(page.data.date)} />
</div>
</Card>
<DocsDescription>{page.data.description}</DocsDescription>
</div>
<DocsDescription className="text-sm">{page.data.description}</DocsDescription>

<DocsBody >
<DocsBody className="font-mono text-sm">
<MDX components={{ ...defaultMdxComponents }} />
</DocsBody>
</DocsPage>
Expand Down
8 changes: 5 additions & 3 deletions apps/engineering/app/rfcs/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ import { baseOptions } from "../layout.config";

export default function Layout({ children }: { children: ReactNode }) {
return (
<DocsLayout tree={rfcSource.pageTree} {...baseOptions}>
{children}
</DocsLayout>
<div className="font-mono">
<DocsLayout tree={rfcSource.pageTree} {...baseOptions}>
{children}
</DocsLayout>
</div>
);
}
33 changes: 33 additions & 0 deletions apps/engineering/content/rfcs/0000-template.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: 0000 Template
description: You may copy this as a starting point, but it's not required
date: 2024-11-25
authors:
- Andreas Thomas
- Someone Else
---


## Summary

One paragraph explanation of the feature.

## Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

## Detailed design

This is the bulk of the RFC. Explain the design in enough detail for somebody familiar with the network to understand, and for somebody familiar with the code practices to implement. This should get into specifics and corner-cases, and include examples of how the feature is used.

## Drawbacks

I Why should we not do this?

## Alternatives

What other designs have been considered? What is the impact of not doing this?

## Unresolved questions

What parts of the design are still to be done?
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 0002 GitHub Secret Scanning
title: 0002 Secret Scanning
authors:
- Dom Eccleston
date: 2024-01-14
Expand Down
Loading
Loading