Reference docs generation and plan. #319
Conversation
src/extrinsic/index.ts
Outdated
| @@ -107,3 +113,5 @@ export default class ExtrinsicBaseClass { | |||
| return freeTxWrapper | |||
| } | |||
| } | |||
|
|
|||
| export default ExtrinsicBaseClass | |||
There was a problem hiding this comment.
this change was needed to preserve the names of exports in docs 🤷
|
@frankiebee / @rh0delta this is ready for a review. One thing we need to decide is what we want that site to look like. Currently that ugly HTML page has an ... on site map nested thing on the left but it's ... awkwardly named. Like it doesn't line up with what we export from the |
|
Ideally, if there's a way to spit out this stuff into regular old markdown files, then we can port it over to the main docs repo. Is that even a thing we can do? |
|
Decision: we need to have a documentation meeting |
|
@frankiebee please review |
johnnymatthews
changed the title
johnnymatthews
added
the
documentation
|
Created a relevant issue for planning over in Docs: entropyxyz/entropy-docs#121 |
|
@johnnymatthews can we merge this? |
|
Found a plugin which makes the entry points (sections on left) less of a mess Also started adding some
|
|
Hey I want this PR merged or closed this week. |
| - `main` | ||
| "stable" what is on npm | ||
|
|
||
| - `<name>/<issue_number>-<short_title>` (personal branches) |
There was a problem hiding this comment.
Is issue number required for the branch name? Will this now be the new standard? More often than not, our branches don't include the issue number in the name, but rather required in the PR description prefixed by "closes" or "fixes" or something along those lines
There was a problem hiding this comment.
I think I copied this from notes from a call with frankie. I'm not sure I care about issue number.
Let's discuss
| - `<name>/<issue_number>-<short_title>` (personal branches) | ||
| for example `frankie/i123-docs` | ||
|
|
||
| all PRS go into `dev` |
There was a problem hiding this comment.
Should we make a comment about hotfix prs going straight to main?
There was a problem hiding this comment.
nice. Those would be patch releases aye?
i feel like we could make a patch branch. Basically anything we write ha gotta get smoke testing befor going into main + published...
depends how many patches we expect. What I'm being cautious of is "special shorcuts". They can cause problems
|
|
||
| The SDK version must match a compatible [`entropy-core`](https://github.com/entropyxyz/entropy-core) version. | ||
|
|
||
| <!-- TODO: --> |
There was a problem hiding this comment.
What's this here for?
There was a problem hiding this comment.
An invisible comment!
i think I'd like to see a thing there where we list the details of the compatible versions of things.
this was just from using other sdks where it became a nightmare to know how to run a compatible network of tools cos the versions of things which work together was not well documented.
i may have trauma
mega PR for us to jam on till it's done (as discussed with Frankie)
The aim of this PR is to :
README.mda chill into + link out to further resourcesdocs/into a rich websiteWhat the website will look like: