Move developer-hub to sdk-docs
#2565
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…k into kiz-developer-hub
…k into kiz-developer-hub
Co-authored-by: Juan Girini <juangirini@gmail.com>
Co-authored-by: bader y <ibnbassem@gmail.com>
Co-authored-by: bader y <ibnbassem@gmail.com>
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
Co-authored-by: Juan Girini <juangirini@gmail.com> Co-authored-by: Sebastian Kunert <skunert49@gmail.com> Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> Co-authored-by: Juan Girini <juangirini@gmail.com> Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
5 tasks
liamaharon
approved these changes
Nov 30, 2023
juangirini
added
the
T11-documentation
|
The CI pipeline was cancelled due to failure one of the required jobs. |
rmnprkrl
reviewed
Dec 1, 2023
| @@ -125,7 +125,7 @@ build-rustdoc: | |||
| find "$path" -name '*.html' | xargs -I {} -P "$(nproc)" bash -c 'process_file "$@"' _ {} | |||
| } | |||
| inject_simple_analytics "./crate-docs" | |||
| - echo "<meta http-equiv=refresh content=0;url=polkadot_service/index.html>" > ./crate-docs/index.html | |||
| - echo "<meta http-equiv=refresh content=0;url=developer_hub/index.html>" > ./crate-docs/index.html | |||
There was a problem hiding this comment.
that def needs to be updated, @juangirini worth doing a global search / grep of the workspace for developer_hub before merging this if you haven't already
There was a problem hiding this comment.
sorry guys, there's been some rebase conflicts that broke the PR after changing its base to master, I'll try to fix this PR, otherwise I'll close it and open a new one
| @@ -0,0 +1,14 @@ | |||
| flowchart | |||
| parity[paritytech.github.io] --> devhub[developer_hub] | |||
There was a problem hiding this comment.
should reference the folder or the crate:
- "docs/sdk"
- "sdk-docs"
| @@ -0,0 +1,54 @@ | |||
| <script> | |||
There was a problem hiding this comment.
rust docs template references "developer_hub"
| //! * [`substrate`], for an overview of what Substrate as the main blockchain framework of Polkadot | ||
| //! SDK. | ||
| //! * [`frame`], to learn about how to write blockchain applications aka. "App Chains". | ||
| //! * Continue with the [`developer_hub`'s "getting started"](crate#getting-started). |
| @@ -34,14 +30,21 @@ | |||
| //! > **F**ramework for **R**untime **A**ggregation of **M**odularized **E**ntities: Substrate's | |||
| //! > State Transition Function (Runtime) Framework. | |||
| //! | |||
| //! ## Documentation | |||
| //! | |||
| //! See [`polkadot_sdk::frame`](../developer_hub/polkadot_sdk/frame_runtime/index.html). | |||
|
regarding the crate name, do you think it is worth to consider "sdk-docs" vs "polkadot-sdk-docs"? |
|
closed in favour of #2598 |
juangirini
added a commit
that referenced
this pull request
Dec 5, 2023
This PR is a continuation of #2102 and part of an initiative started here https://hackmd.io/@romanp/rJ318ZCEp What has been done: - The content under `docs/*` (with the exception of `docs/mermaid`) has been moved to `docs/contributor/` - Developer Hub has been renamed to Polkadot SDK Docs, and the crate has been renamed from `developer-hub` to `polkadot-sdk-docs` - The content under `developer-hub/*` has been moved to `docs/sdk` --- Original PR #2565, it has been close due to too many rebase conflicts --------- Co-authored-by: Serban Iorga <serban@parity.io> Co-authored-by: Chevdor <chevdor@users.noreply.github.com> Co-authored-by: Egor_P <egor@parity.io> Co-authored-by: Bastian Köcher <git@kchr.de>
bgallois
pushed a commit
to duniter/duniter-polkadot-sdk
that referenced
this pull request
Mar 25, 2024
This PR is a continuation of paritytech#2102 and part of an initiative started here https://hackmd.io/@romanp/rJ318ZCEp What has been done: - The content under `docs/*` (with the exception of `docs/mermaid`) has been moved to `docs/contributor/` - Developer Hub has been renamed to Polkadot SDK Docs, and the crate has been renamed from `developer-hub` to `polkadot-sdk-docs` - The content under `developer-hub/*` has been moved to `docs/sdk` --- Original PR paritytech#2565, it has been close due to too many rebase conflicts --------- Co-authored-by: Serban Iorga <serban@parity.io> Co-authored-by: Chevdor <chevdor@users.noreply.github.com> Co-authored-by: Egor_P <egor@parity.io> Co-authored-by: Bastian Köcher <git@kchr.de>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a continuation of #2102 and part of an initiative started here https://hackmd.io/@romanp/rJ318ZCEp
What has been done:
docs/*(with the exception ofdocs/mermaid) has been moved todocs/contributor/developer-hubtosdk-docsdeveloper-hub/*has been moved todocs/sdk