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.

Sign up for GitHub

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

Jump to bottom

docs: fix broken dev-portal link and exclude framework lifecylce docs #505

Merged
merged 3 commits into from
Nov 22, 2023
Merged

docs: fix broken dev-portal link and exclude framework lifecylce docs #505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4e2c8a3
docs: fix broken dev portal build
heueristik Nov 22, 2023
6e41ddc
docs: fix broken dev portal link
heueristik Nov 22, 2023
01c02f4
ci: exclude framework lifecycle docs from developer portal
heueristik Nov 22, 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
3 changes: 3 additions & 0 deletions .github/workflows/documentation-update.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ jobs:
- name: Generate Docs
run: yarn run docgen
working-directory: packages/contracts/
- name: Remove Framework Lifecycle docs
run: rm -rf 04-framework-lifecycle
working-directory: packages/contracts/docs/developer-portal/
- name: Format with prettier
run: yarn run prettier 'packages/contracts/docs/developer-portal/03-reference-guide/**/*.md' --write
- name: Checkout developer-portal
Expand Down
12 changes: 3 additions & 9 deletions packages/contracts/docs/developer-portal/04-framework-lifecycle/01-systems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ with construction / initialization constituting a special.

</div>

<details><summary><b>Interfaces</b></summary>
#### Interfaces

- `IDAO`
- `IPlugin`
Expand All @@ -47,9 +47,7 @@ with construction / initialization constituting a special.
- `IProposal`
- `IMembership`

</details>

<details><summary><b>Abstract Contracts</b></summary>
#### Abstract Contracts

- Non-Upgradable

Expand All @@ -67,9 +65,7 @@ with construction / initialization constituting a special.
- `ProposalUpgradeable`
- `InterfaceBasedRegistry`

</details>

<details><summary><b>Deployed Contracts</b></summary>
#### Deployed Contracts

- Non-Upgradable

Expand All @@ -86,8 +82,6 @@ with construction / initialization constituting a special.
- `PluginUUPSUpgradeable`
- `ENSSubdomainRegistrar`

</details>

## Subgraph

The subgraph is composed of
Expand Down
2 changes: 1 addition & 1 deletion packages/contracts/docs/developer-portal/04-framework-lifecycle/02-semver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ We use the semver notation to version the OSx Protocol smart contract and to cla

## Change Classifications

We now classify [smart contract changes](systems.md#smart-contracts) according to SemVer and how they affect the [the subgraph](01-systems.md#the-subgraph), consumers of the contracts and the subgraph such as the [the SDK or 3rd party projects](systems.md#sdk-3rd-party-projects-contract--subgraph-consumers), and [the App](01-systems.md#app).
We now classify [smart contract changes](01-systems.md#smart-contracts) according to SemVer and how they affect the [the subgraph](01-systems.md#the-subgraph), consumers of the contracts and the subgraph such as the [the SDK or 3rd party projects](01-systems.md#sdk-3rd-party-projects-contract--subgraph-consumers), and [the App](01-systems.md#app).

| SemVer Classification | Change in | Affected contracts | Action | Contract Implication (OSx or 3rd party) | Subgraph | SDK | App |
| --------------------- | -------------------------------------------- | --------------------- | ------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
Expand Down
2 changes: 1 addition & 1 deletion ...eveloper-portal/04-framework-lifecycle/03-osx-components/01-factory-contract.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ Applies to
- `DAOFactory`
- `PluginRepoFactory`

For changes in the underlying implementations (i.e., `DAO` and `PluginRepo`), see the process of [replacing upgradeable contracts](../03-sub-processes/upgradeable-contract.md).
For changes in the underlying implementations (i.e., `DAO` and `PluginRepo`), see the process of [replacing upgradeable contracts](./02-upgradeable-contract.md).
Loading