h2oai/wave

Add @app to the Page Guide

Open

#581 opened on Feb 19, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (279 forks)batch import
docsgood first issue

Repository metrics

Stars
 (3,677 stars)
PR merge metrics
 (Avg merge 2m) (1 merged PR in 30d)

Description

Is your feature request related to a problem? Please describe

The @app('/') feature is explained in the API section of the docs (https://wave.h2o.ai/docs/api/server#app), but is only really find-able if someone is looking for it. When users are on the Pages section of the Guide (https://wave.h2o.ai/docs/pages/) it might be nice for them to explicitly learn about @app() as this is a shortcut for sending apps to a specific page.

Describe the solution you'd like

Add a brief sentence and code snippet to the Pages Guide: https://wave.h2o.ai/docs/pages/

Right after the code for To reference the current page in a Wave app, use q.page.. Here is a first-pass suggestion

image

To reference a specific page in a Wave app, use the `@app(/foo)` decorator

~
@app('/foo')
async def serve(q: Q):
    page = q.page
~

Contributor guide

Research direction
Edit the Pages guide at https://wave.h2o.ai/docs/pages/ to add a sentence and code snippet about the @app() decorator after the existing code for referencing the current page. Follow the suggestion in the issue description, which includes a code snippet using @app('/foo'). Ensure the addition is consistent with the existing documentation style.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonWave framework basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85