Skip to content
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
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,11 @@ npm-debug.log
/**/.env

*.bytecode

# docs
/packages/docs/src/core/_build/
/packages/docs/src/core/pyvenv.cfg
/packages/docs/src/core/lib/
/packages/docs/src/core/_build/
/packages/docs/src/core/bin/
/packages/docs/src/core/env/
2 changes: 1 addition & 1 deletion packages/core-db/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"client"
],
"homepage": "https://github.com/ethereum-optimism/optimism-monorepo/tree/master/packages/core-db#readme",
"bugs": "https://github.com/ethereum-optimism/optimism-monorepo/labels/%40pigi%2Fcore-db",
"bugs": "https://github.com/ethereum-optimism/optimism-monorepo/labels/%40eth-optimism%2Fcore-db",
"license": "MIT",
"author": "Optimism",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion packages/core-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"client"
],
"homepage": "https://github.com/ethereum-optimism/optimism-monorepo/tree/master/packages/core-utils#readme",
"bugs": "https://github.com/ethereum-optimism/optimism-monorepo/labels/%40pigi%2Fcore-utils",
"bugs": "https://github.com/ethereum-optimism/optimism-monorepo/labels/%40eth-optimism%2Fcore-utils",
"license": "MIT",
"author": "Optimism",
"repository": {
Expand Down
Binary file not shown.

This file was deleted.

Binary file not shown.
Binary file removed packages/docs/src/core/_static/images/cant-fake.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
18 changes: 9 additions & 9 deletions packages/docs/src/core/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@

# -- Project information -----------------------------------------------------

project = '@pigi/core'
copyright = '2019, Plasma Group'
author = 'Plasma Group'
project = '@eth-optimism'
copyright = '2020, Optimism'
author = 'Optimism'

# The short X.Y version
version = ''
Expand Down Expand Up @@ -107,7 +107,7 @@
# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'pigicoredoc'
htmlhelp_basename = 'optimismcoredoc'


# -- Options for LaTeX output ------------------------------------------------
Expand All @@ -134,8 +134,8 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'pigicore.tex', '@pigi/core Documentation',
'Plasma Group', 'manual'),
(master_doc, 'optimismcore.tex', '@eth-optimism Documentation',
'Optimism', 'manual'),
]


Expand All @@ -144,7 +144,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'pigicore', '@pigi/core Documentation',
(master_doc, 'optimismcore', '@eth-optimism Documentation',
[author], 1)
]

Expand All @@ -155,8 +155,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'pigicore', '@pigi/core Documentation',
author, 'pigicore', 'One line description of project.',
(master_doc, 'optimismcore', '@eth-optimism Documentation',
author, 'optimismcore', 'One line description of project.',
'Miscellaneous'),
]

Expand Down
40 changes: 6 additions & 34 deletions packages/docs/src/core/index.rst
Original file line number Diff line number Diff line change
@@ -1,44 +1,16 @@
========================
@pigi/core documentation
@eth-optimism Documentation
========================
Hello and welcome to the documentation for Plasma Group's ``@pigi/core``!
``@pigi/core`` is the set of core modules that our other plasma chain clients use.

**A quick note:** ``@pigi/core`` is **not** our ``Node.js`` client, ``@pigi/client``.
Documentation for ``@pigi/client`` is available at the `@pigi/client docs`_.
Hello and welcome to the documentation for Optimism's ``@eth-optimism``!
``@eth-optimism`` is the set of core modules that the OVM and our L2 implementations use.

.. toctree::
:maxdepth: 2
:caption: Developer Documentation

src/what-is-pigi-core
src/architecture
src/extending-pigi-core
src/reference
:caption: Developer Documentation2


.. toctree::
:maxdepth: 2
:caption: Specifications

src/specs/operator
src/specs/coin-assignment
src/specs/transactions
src/specs/proofs
src/specs/contract
src/specs/sum-tree
src/specs/jsonrpc

.. toctree::
:maxdepth: 2
:caption: Service API Reference

src/services/contract
src/services/operator
src/services/jsonrpc
src/services/proof
src/services/sync
src/services/chain
src/services/guard
src/services/db

.. _`@pigi/client docs`: https://docs.plasma.group/projects/client/en/latest/

90 changes: 0 additions & 90 deletions packages/docs/src/core/src/architecture.rst

This file was deleted.

48 changes: 0 additions & 48 deletions packages/docs/src/core/src/extending-pigi-core.rst

This file was deleted.

Loading