Skip to content

chore(docs): outline for 0.4#149

Merged
reecepbcups merged 56 commits intomainfrom
docs-0.4
May 26, 2025
Merged

chore(docs): outline for 0.4#149
reecepbcups merged 56 commits intomainfrom
docs-0.4

Conversation

@evanorti
Copy link
Contributor

@evanorti evanorti commented May 9, 2025

Tagging with todos and creating a new structure for the handbook. I've added some new sections on triggers, manifest, etc.

The service handbook should follow the general structure of the service manifest and explain every part and available options. How it works becomes more like an overview of the pages of the handbook.

Next week we will fill this out more and refine. We can update the sections after changes to the template and wavs are finalized.

Note: The entire tutorial needs to be updated with the new template flow once that is finalized.

@evanorti evanorti changed the base branch from 0.3 to main May 9, 2025 19:56
Copy link
Member

@reecepbcups reecepbcups left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work, I know you are refinding more monday but giving a stamp of approval now. will review then or if you want to merge that works too

@reecepbcups
Copy link
Member

cc @evanorti can you pull over the fix from https://github.com/Lay3rLabs/WAVS-docs/pull/45/files here as well? (both in docs & the main readme)

@reecepbcups
Copy link
Member

reecepbcups commented May 26, 2025

Note: #164 & Lay3rLabs/WAVS-docs#55 depends on this PR first

@reecepbcups
Copy link
Member

reecepbcups commented May 26, 2025

TODO

  • review docs/handbook (semi updated to 0.4, need to review / add any changes in recent weeks)
  • docs/handbook/commands.mdx need to be updated from make help. What they are and what they do.
  • [ ] Update all of the oracle tutorial (for local). make mention of testnet New pr

@reecepbcups reecepbcups changed the title Docs planning/outline for 0.4 chore(docs): outline for 0.4 May 26, 2025
@reecepbcups
Copy link
Member

I am going to change scope of this PR to just the outside docs of 0.4 (not the tutorial). I will do that in its own PR to limit size


A component is defined in the [workflow](../workflows) object of the [service.json](../service) file. Below is an example of the different fields that can be defined in the component object.

```json service.json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does feel like we define component sources many times. We should link out maybe if we do

service.mdx, workflows.mdx, and component.mdx. or we give just the very specific sections for each at each. I think 1 large service json file would be better utilized

@reecepbcups reecepbcups marked this pull request as ready for review May 26, 2025 20:50
@reecepbcups
Copy link
Member

Looks good 🫡 Will get the tutorial fix work in another PR

@reecepbcups reecepbcups merged commit 59abb6f into main May 26, 2025
5 checks passed
@reecepbcups reecepbcups deleted the docs-0.4 branch May 26, 2025 20:51
@reecepbcups reecepbcups mentioned this pull request May 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants