Skip to content

Push develop to main to trigger search index and test flow. #19

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

Merged
merged 34 commits into from
Aug 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
500c168
first wave of changes
dghelm Aug 4, 2023
33d7db6
prep for Ahmed to work on Developer articles
dghelm Aug 4, 2023
393f2fd
update latest ui changes
dghelm Aug 4, 2023
f68f1b7
fix build errors from md frontmatter
dghelm Aug 4, 2023
abe5416
briding docs file structure
Turupawn Aug 4, 2023
af84a83
replaced Goerli and Scroll Alpha mentions with L1 and L2
Turupawn Aug 4, 2023
6ccad50
some styling
Turupawn Aug 4, 2023
56982be
added guides
Turupawn Aug 4, 2023
69ad026
content changes before font fix
dghelm Aug 5, 2023
520b6f4
Merge branch 'ui-refactor' into sepolia-content-population
dghelm Aug 5, 2023
6740b55
content changes before mermaid test
dghelm Aug 5, 2023
cec599d
install rehype-mermaidjs
dghelm Aug 5, 2023
5c60cf6
fix build dep for mermaid
dghelm Aug 5, 2023
361bb4c
Merge remote-tracking branch 'origin/dev-content' into sepolia-conten…
dghelm Aug 5, 2023
91f4032
Merge pull request #17 from scroll-tech/sepolia-content-population
Turupawn Aug 5, 2023
cf7637b
developer doc content updates, fix frontpage links
dghelm Aug 5, 2023
e8a090d
Merge remote-tracking branch 'origin/dev-content' into sepolia-conten…
dghelm Aug 5, 2023
ab8ff65
enforced tx + permalinks + excerpts
Turupawn Aug 5, 2023
7a7d691
remove 'es' locale until I can troubleshoot build process
dghelm Aug 5, 2023
7bbdfb0
Merge branch 'sepolia-content-population' into dev-content
Turupawn Aug 5, 2023
80d2030
fixed enforced-transactions page name
Turupawn Aug 5, 2023
4ed3b82
Merge branch 'dev-content' of https://github.com/scroll-tech/scroll-d…
Turupawn Aug 5, 2023
4e36500
migrate tx fees article
dghelm Aug 5, 2023
0e764d9
fix sepolia rpc url
dghelm Aug 6, 2023
431ad58
Merge remote-tracking branch 'origin/dev-content' into sepolia-conten…
dghelm Aug 6, 2023
d7bc77f
Merge branch 'ui-refactor' into sepolia-content-population
dghelm Aug 6, 2023
a27c864
vertical centering of right side nav elements
dghelm Aug 6, 2023
2dc978b
fix breakpoints, adjust to em, refactor NavCard, basic responsive beh…
dghelm Aug 6, 2023
6580ce6
prep Search work and test with branch
dghelm Aug 6, 2023
9dea838
name github index action and fix env for index usage
dghelm Aug 6, 2023
1a60800
merge ui-refactor
dghelm Aug 7, 2023
47280aa
update Sepolia contract addresses, tidy mindmark
dghelm Aug 7, 2023
40fd10b
update Uniswap contract addresses
dghelm Aug 7, 2023
2831036
Merge pull request #13 from scroll-tech/sepolia-content-population
dghelm Aug 7, 2023
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
23 changes: 22 additions & 1 deletion .github/workflows/update-algolia-index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,28 @@ on: [push]
jobs:
update-prod-index:
if: ${{ github.ref == 'refs/heads/main' }}
name: Update algolia index
name: Update algolia index -- Prod
runs-on: ubuntu-latest
env:
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
ALGOLIA_WRITE_API_KEY: ${{ secrets.ALGOLIA_WRITE_API_KEY }}
ALGOLIA_INDEX_NAME: prod_scroll-docs
defaults:
run:
working-directory: ./
steps:
- name: Checkout Repo
uses: actions/checkout@v3
- name: Install Dependencies
run: npm i
- name: Build
run: npm run build
- name: Update index
run: npm run update-algolia-index

update-dev-index:
if: ${{ github.ref == 'refs/heads/develop' || github.ref == 'refs/heads/sepolia-content-population' }}
name: Update algolia index -- Dev
runs-on: ubuntu-latest
env:
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
Expand Down
18 changes: 12 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
# Contributing to the Scroll Documentation

PRs are welcome! We try to keep a clean commit history, so we'll follow a standard process initially created by the Chainlink team whose documentation we forked:
As we build out the initial scope of the documentation, we intend to be selective about PRs, especially in our English language documentation. If you're interested in making a code or content contribution, please start by creating an issue and discussing the idea with a member of our team.

- Create a PR
If you want information about contributing a translation, please see [TRANSLATION.md](./TRANSLATION.md).

We try to keep a clean commit history, so we'll follow a standard process initially created by the Chainlink team whose documentation we forked:

- Create a new issue
- Comment on the issue if you'd like to be assigned to it
- Fork the Repo & Create a PR
- If your PR contains multiple commits, we'll ask you to squash them
- If your PR has conflicts with `main`, we'll ask you to rebase it
- If your PR has conflicts with `develop`, we'll ask you to rebase it
- Someone will review your PR
- Your PR will be merged, amended, closed, or you'll be asked for changes

## Standards

- Commit messages
- Start with a present tense verb
- Start with a present-tense verb
- Keep your commit headline short but sufficient to understand the scope and focus of the change.
- Changes are often formatted like `add doc X`, `fix page Y`, `improve docs for Z`.
- Example: "`update contract addresses for BSC`".
- Example: "`update contract addresses for USDC on Scroll Sepolia`".
- If you touch any infrastructure, make sure it builds with `yarn build`
- Trust the autoformatter (prettier)
- Make sure images are optimized and compressed
Expand All @@ -29,7 +35,7 @@ git rebase origin/main
git push -f
```

It's okay to force push over your own PR branch. In fact, that's what we want so that the commits are clean.
It's okay to force push over your own PR branch. That's what we want so that the commits are clean.

## How to squash a PR

Expand Down
26 changes: 26 additions & 0 deletions TRANSLATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Translation Initiative

_Our translation initiative hopes to translate Scroll documentation into different languages and make the website accessible to people worldwide._

Our current documentation is only available in English, but with community contributions, we want to support many language communities. Since this is a new initiative and we want to maintain high assurances about the information in our documentation, **we're only accepting contributions in Mandarin and Spanish**. Once we're comfortable with the process and can ensure a good experience for community translators, we'll seek contributions in additional languages.

### Want to get involved as a translator?

Create an issue describing which article you wish to translate. Then get started! If you need help or have any questions, join the [Scroll Discord](https://discord.gg/scroll). Once your translation is submitted, we'll ask a member of our team to do a review.

### Standards and Policies

For now, we will defer to Ethereum.org's excellent [Translation Style Guide](https://ethereum.org/en/contributing/translation-program/translators-guide/). We do not use a translation platform, but please assume all other guidance applies here.

## Starting a translation

1. Fork this repository
1. Create an issue named using the format "Translation: _[English Article Name]_ (_[lang]_)" -- for example, "Translation: User Guide Faucet (zh)"
1. Find the article you wish to translate in `src/content/docs/en/` and copy it to a matching folder in `src/content/docs/[lang]/`. All files should maintain the same file name and folder structure as the English version of the site.
1. To translate UI elements or article names, modify the appropriate entry in `public/locales/[lang]/translation.json`. If you're unsure what to do here, suggest any additional changes to the site in your PR.
1. Make a PR with the title following the template above. Be sure to mention the original issue in your description.
1. A team member will review, recommend changes and work with you to get the final version added to the code base.

### Not familiar with Git?

If you don't want to worry about all this Git stuff, contact a team member or community moderator on the [Scroll Discord](https://discord.gg/scroll). We'd be happy to point you at the original file to translate and suggest an online text editor (like [HackMD](https://hackmd.io/)) for sharing your results. We'll take it from there.
2 changes: 2 additions & 0 deletions astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import mdx from "@astrojs/mdx"
import rehypeSlug from "rehype-slug"
import rehypeAutolinkHeadings from "rehype-autolink-headings"
import rehypeKatex from "rehype-katex"
import rehypeMermaid from "rehype-mermaidjs"
import remarkGfm from "remark-gfm"
import remarkMath from "remark-math"
import image from "@astrojs/image"
Expand Down Expand Up @@ -51,6 +52,7 @@ export default defineConfig({
remarkPlugins: [remarkMath, remarkGfm],
rehypePlugins: [
rehypeSlug,
[rehypeMermaid, { strategy: "img-png" }],
[
rehypeAutolinkHeadings,
{
Expand Down
Loading