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

Use the common documentation from google/open-source-pdks repository #24

Merged
merged 4 commits into from
Jul 25, 2022
Merged
Show file tree
Hide file tree
Changes from 2 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
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,6 @@
url = https://github.com/google/globalfoundries-pdk-ip-gf180mcu_fd_ip_sram.git
branch = main
shallow = true
[submodule "third_party/open-source-pdks"]
path = third_party/open-source-pdks
url = https://github.com/google/open-source-pdks.git
8 changes: 8 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
This project follows the [Google Open Source Community Guidelines](https://opensource.google/conduct).
mithro marked this conversation as resolved.
Show resolved Hide resolved

A copy of these guidelines can be found locally in this repository at
[docs/open-source-pdks/code-of-conduct.rst](./docs/open-source-pdks/code-of-conduct.rst).

A copy of these guidelines are also
[included in the published documentation](https://gf180mcu-pdk.readthedocs.io/en/latest//open-source-pdks/code-of-conduct.html)
located at <https://gf180mcu-pdk.rtfd.io>.
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Guidelines for contributing can be found locally in this repository at
mithro marked this conversation as resolved.
Show resolved Hide resolved
[docs/open-source-pdks/contributing.rst](./docs/open-source-pdks/contributing.rst).

A copy of these guidelines are also
[included in the published documentation](https://gf180mcu-pdk.readthedocs.io/en/latest//open-source-pdks/contributing.html)
located at <https://gf180mcu-pdk.rtfd.io>.
68 changes: 0 additions & 68 deletions docs/code-of-conduct.rst

This file was deleted.

36 changes: 0 additions & 36 deletions docs/contributing.rst

This file was deleted.

2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Welcome to GlobalFoundries 0.18UM 3.3V/(5V)6V MCU PDK's documentation!
IPs/ips
physical_verification/design_man

open-source-pdks/index

.. warning::
This documentation is currently a **work in progress**.

Expand Down
1 change: 1 addition & 0 deletions docs/open-source-pdks
1 change: 1 addition & 0 deletions third_party/open-source-pdks
Submodule open-source-pdks added at fd509b