Skip to content

Commit

Permalink
Merge pull request #3145 from ethereum/cnLang
Browse files Browse the repository at this point in the history
update index.rst, layout page & copyright
  • Loading branch information
ryestew committed Jul 5, 2023
2 parents 1deb726 + 55264a5 commit dd2dbb3
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@

# General information about the project.
project = u'Remix - Ethereum IDE'
copyright = u'2019-22, Remix;'
copyright = u'2019-23, Remix;'
author = u'Remix Team'

github_doc_root = 'https://github.com/ethereum/remix-ide/tree/master/docs'
Expand Down
Binary file modified docs/images/a-hometab.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Supported browsers: Firefox, Chrome, Brave. We do not support use of Remix on ta
**Ethereum Remix**, the VSCode extension, see `here <https://marketplace.visualstudio.com/items?itemName=RemixProject.ethereum-remix>`__.
Documentation for the VSCode extension is located `here <https://github.com/ethereum/remix-vscode#ethereum-remix-project-extension-for-visual-studio-code>`__.

**Remix Documentation Translations** The Remix docs are currently in `English <https://remix-ide.readthedocs.io/en/latest/>`__ and `Simplied Chinese <https://remix-ide.readthedocs.io/zh_CN/latest/>`__. More languages are on the way.

Remix Project
~~~~~~~~~~~~~
Remix IDE is part of the `Remix Project <https://github.com/ethereum/remix-project>`__ which also includes the
Expand Down Expand Up @@ -48,7 +50,7 @@ Useful links:

.. toctree::
:maxdepth: 2
:caption: New Layout Intro
:caption: Layout and Panels

layout

Expand Down
30 changes: 15 additions & 15 deletions docs/layout.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
Remix-IDE Layout
==============
Navigating Remix
================
Remix IDE is comprised of three panels and a terminal.

The new structure
--------------------
![](images/a-layout1c.png)

1. Icon Panel - click to change which plugin appears in the Side Panel
2. Side Panel - Most but not all plugins will have their GUI here.
3. Main Panel - In the old layout this was just for editing files. In the tabs can be plugins or files for the IDE to compile.
4. Terminal - where you will see the results of your interactions with the GUI's. Also you can run scripts here.
1. Icon Panel - click to change which plugins appear in the Side Panel
2. Side Panel - most but not all plugins have their interface here
3. Main Panel - for editing files, large format tools, and the home tab
4. Terminal - for viewing transaction receipts and various logs

Icon Panel at Page Load
Default Tools
-----------------------
When you load remix - the icon panel show these icons by default.

When Remix is loaded - the icon panel shows these icons by default.

![](images/a-icons-at-load.png)

Everything in Remix is a plugin... so the **[Plugin Manager](#plugin-manager)** is very important.
To load more plugins go to the **[Plugin Manager](#plugin-manager)** or click on one of the featured plugins in the home tab.

Home tab
--------

![](images/a-hometab.png)

The home tab is located in the Main Panel. It can be closed. <br> You can also access it (even if closed) by clicking the Remix logo at the top of the icon panel.
The home tab is located in the Main Panel. It can be closed, just like any of the main panel tabs. <br> You can also access it (even if closed) by clicking the Remix logo at the top of the icon panel.

The hometab contains links to resources - including links to these docs as well as our Twitter feed, our Medium blog, gitter chat and more. There are also shortcuts for loading files into Remix.
The home tab contains links to resources, announcements, tutorials, featured plugins and methods for loading files into Remix and shortcuts for connecting Remix to your local filesystem.

### Solidity Environment
### Solidity
Clicking the **Solidity button** in the featured plugins section of the home tab will activate **Solidity Static Analysis** and **Solidity Unit Testing** as well as the Solidity Compiler and Deploy & Run (which are there by default).

To see all the plugins go to the **Plugin Manager** - by selecting the plug in the icon panel.
Expand All @@ -44,6 +44,6 @@ The Plugin Manager is also the place you go when you are creating your own plugi
Themes
---------------

So you want to work on Remix with a dark theme or a light theme or just a different theme than the one you are currently looking at? At the bottom of the **Settings** plugin is where you can choose a theme. These are bootstrap based themes. The Dark and Light theme have been the most customized for Remix.
Themes are chosen at the bottom of the **Settings** plugin. These are Bootstrap-based themes. The Dark and Light themes are most customized for Remix.

![](images/a-themes.png)

0 comments on commit dd2dbb3

Please sign in to comment.