Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

content/issue 31 Docs pages #117

Merged
merged 26 commits into from
Oct 31, 2024
Merged

Conversation

thescientist13
Copy link
Member

@thescientist13 thescientist13 commented Oct 22, 2024

Related Issue

resolves #31

Summary of Changes

  1. Created Docs pages, lifted / shifted docs from the old site (created a shared CSS file between this and the Guides pages)
  2. Integrated Edit on GitHub button
  3. Documents Rendering Strategies (prerender vs SSR vs CSR) greenwood#951
  4. Introduced a new Reference section to the docs

TODO

  1. Welcome content
  2. set color of popover x icons coloring on mobile (otherwise default color is blue)
  3. final content review / drafting / links check
    • Check headings and casings (TypeScript, Plugin APIs)
    • Call out our influences
    • typeof catch for SSR + WCs escape hatch
    • GWD build environment variable
    • Npm callout for peer deps
    • Front matter as an array example - there's an example already in the imports section
  4. track all Location redirects / audit of all old routes and deprecations - Website redesign, branding, and long term structure greenwood#978
    • /about/* -> /docs/introduction/about/
    • /plugins/ -> /docs/references/plugins-api/
    • /plugins/adapter/ -> /docs/reference/plugins-api/#adapter
    • /plugins/context/ -> /docs/reference/plugins-api/#context
    • /plugins/copy/ -> /docs/reference/plugins-api/#copy
    • /plugins/renderer/ -> /docs/reference/plugins-api/#renderer
    • /plugins/resource/ -> /docs/reference/plugins-api/#resource
    • /plugins/rollup/ -> /docs/reference/plugins-api/#rollup
    • /plugins/server/ -> /docs/reference/plugins-api/#server
    • /plugins/source/ -> /docs/reference/plugins-api/#source
    • /plugins/custom-plugins/ -> /docs/plugins/
    • /docs/component-model/ -> /docs/introduction/web-standards/#web-components
    • /docs/configuration/ -> /docs/reference/configuration/
    • /docs/front-matter/ -> /docs/resources/markdown/
    • /docs/markdown/ -> /docs/resources/markdown/#frontmatter
    • /docs/scripts/ -> /docs/resources/scripts/
    • /docs/css-and-images/ -> /docs/resources/styles/
    • /docs/layouts/ -> /docs/pages/layouts/
    • /docs/server-rendering/ -> /docs/pages/server-rendering/
    • /docs/api-routes/ -> /docs/pages/api-routes/
    • /docs/menus/ -> /docs/content-as-data/collections/
    • /docs/data/ -> /docs/content-as-data/
  5. fix the active frontmatter example for <title>My Blog - ${globalThis.page.title}</title> showing up as null on /docs/content-as-data/active-frontmatter/ page
  6. final feedback - content/issue 31 Docs pages #117 (review)

Questions

  1. where should plugin (README) docs go (not launch blocking)? - Plugin Docs (READMEs) and website co-location #114 (comment)
  2. Smaller font size on mobile (match blog post) - from the call, we agreed bigger font in the docs was preferable
  3. Bun / deno callouts on hosting section? - not right now, will save for Agnostic Runtime greenwood#953

@thescientist13 thescientist13 added question Further information is requested content Non Greenwood specific content like home page copy text, blog posts, etc labels Oct 22, 2024
Copy link

netlify bot commented Oct 22, 2024

Deploy Preview for super-tapioca-5987ce ready!

Name Link
🔨 Latest commit dc91f20
🔍 Latest deploy log https://app.netlify.com/sites/super-tapioca-5987ce/deploys/6723b4c42d99be000884cb4e
😎 Deploy Preview https://deploy-preview-117--super-tapioca-5987ce.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@thescientist13 thescientist13 changed the title Content/issue 31 docs pages dontent/issue 31 docs pages Oct 22, 2024
@thescientist13 thescientist13 changed the title dontent/issue 31 docs pages content/issue 31 docs pages Oct 22, 2024
@thescientist13 thescientist13 changed the title content/issue 31 docs pages content/issue 31 Docs pages Oct 22, 2024
@thescientist13 thescientist13 added the enhancement New feature or request label Oct 22, 2024
@thescientist13 thescientist13 marked this pull request as ready for review October 23, 2024 03:20
Copy link
Member Author

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

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

Some good final feedback from the meeting today, was knock down the drop shadow on the side nav active heading and ToC box (to --shadow-2)
Screenshot 2024-10-30 at 8 02 16 PM
Screenshot 2024-10-30 at 8 04 51 PM

@thescientist13 thescientist13 merged commit b27f919 into main Oct 31, 2024
5 checks passed
@thescientist13 thescientist13 deleted the content/issue-31-docs-pages branch October 31, 2024 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Non Greenwood specific content like home page copy text, blog posts, etc enhancement New feature or request question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs Page
1 participant