Skip to content

Commit

Permalink
feat: general cleanup of links, words, etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
squdgy committed Nov 29, 2024
1 parent fbc776a commit ed98174
Show file tree
Hide file tree
Showing 30 changed files with 122 additions and 16,249 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/general_docs_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: General docs request
about: Template for general documentation requests from the Optimism Collective
about: Template for general documentation requests for the Metal L2 docs
title: "[DOCS] Add PR title"
labels: 'community-request,documentation'

Expand All @@ -20,4 +20,4 @@ Provide links to any related content pages for this documentation request. This

## Additional Context
Provide any additional context about this documentation request. What problems did you run into that caused you to make this request?
Which existing documentation pages did you already try as a solution to your problem? Why do you think the requested page(s) will be beneficial to developers in the Optimism Collective?
Which existing documentation pages did you already try as a solution to your problem? Why do you think the requested page(s) will be beneficial to developers working with Metal L2?
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Metal L2's documentation is open-source, hosted on GitHub in the `MetalPay/metal

The Metal L2 Documentation team reviews pull requests and either merges, requests changes, or comments and closes the pull request. You can open a documentation pull request by:

- forking the `docs` repository and working locally,
- forking the `metal-l2-docs` repository and working locally,
- or, for smaller updates, clicking the `Edit this page` link on the right side of any documentation page to directly edit in GitHub.

Contributing to the Metal L2 documentation implies 2 steps:
Expand Down
8 changes: 4 additions & 4 deletions notes/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Optimism Docs Docs
# Metal L2 DocsDocs

The Optimism Docs Docs are internal docs to help you understand how the Optimism Docs are built and maintained.
The Metal L2 DocsDocs are internal docs to help you understand how the Metal L2 Docsare built and maintained.

- [How the Optimism Docs Use Nextra](./nextra.md)
- [How the Optimism Docs Use Remark](./remark.md)
- [How the Metal L2 DocsUse Nextra](./nextra.md)
- [How the Metal L2 DocsUse Remark](./remark.md)
- [GitHub Actions](./actions.md)
4 changes: 2 additions & 2 deletions notes/nextra.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How the Optimism Docs Use Nextra
# How the Metal L2 DocsUse Nextra

The Optimism Docs use the [Nextra](https://nextra.site/) documentation framework.
The Metal L2 Docsuse the [Nextra](https://nextra.site/) documentation framework.
Nextra is essentially a combination of [Next.js](https://nextjs.org/) + [MDX](https://mdxjs.com/) and allows you to write React components that can be used within Markdown pages.
Nextra documentation is decent and can explain the basics of how to do most of the things you might want to do.
This page documents all of the things that we do that are currently not made obvious by Nextra's docs.
Expand Down
Loading

0 comments on commit ed98174

Please sign in to comment.