Skip to content

www: Various documentation improvements#1635

Merged
marvinhagemeister merged 11 commits into
freshframework:mainfrom
marvinhagemeister:docs-app-wrapper
Aug 16, 2023
Merged

www: Various documentation improvements#1635
marvinhagemeister merged 11 commits into
freshframework:mainfrom
marvinhagemeister:docs-app-wrapper

Conversation

@marvinhagemeister

@marvinhagemeister marvinhagemeister commented Aug 15, 2023

Copy link
Copy Markdown
Contributor
  • We call _app.tsx app wrapper in our docs but in the code they were called appTemplate. Switched that over to appWrapper everywhere
  • Updated the Layouts docs and call it Layouts instead of Route Layouts
  • Delete the setting the lang page in the canary docs as that was only necessary in older Fresh version's, because you couldn't render the <html> tag yourself. With Fresh 1.4 you can.
  • Merge Route Groups doc into Routing.
  • Change title of middleware docs to Middlewares instead of Route middlewares.
  • Add documentation for defineApp, defineLayout and defineRoute

@deer deer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great cleanup!

Comment thread docs/toc.ts
link: "latest",
pages: [
["modifying-the-head", "Modifying the <head>", "link:latest"],
["setting-the-language", "Setting the language", "link:latest"],

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is setting the language now such an obvious thing that the documentation should be deleted? Or could it be beneficial to completely redo the example to account for the new functionality?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Setting the language is now mostly:

  1. Open the _app.tsx file
  2. Add the lang attribute to the <html>-tag

Not sure if we need a full page for that. I'd rather have a note for that on a page that deals with internationalization overall. Like it shows how to parse the Accept header (or uses a lib for that), how to user translation strings and as part of that a short section on setting the lang attribute.

Comment thread docs/latest/concepts/routing.md Outdated
marvinhagemeister and others added 2 commits August 16, 2023 16:04
Co-authored-by: Reed von Redwitz <reed+github@vonredwitz.com>
@marvinhagemeister marvinhagemeister merged commit b2362da into freshframework:main Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants