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

docs(docs): added new api section and refactor to pages #951

Merged
merged 14 commits into from
Jul 8, 2024
Merged

Conversation

boyney123
Copy link
Contributor

@boyney123 boyney123 commented Jul 2, 2024

A WIP pull request, to start to demo the documentation v2 RFC and fixed winglang/wing#6829

This PR mainly focuses on moving pages into the new section (API), or and rearranging pages we already have into relevant sub folders. Next phase will be adding new content and further refactorings.

See the changes here in the preview environment

List of changes

Navigation changes

  • New Learn heading in nav bar (previously docs)
  • New API heading in nav bar
  • New Examples heading in nav bar (will be examples/patterns custom page in the future)

API Section

Learn Section (previously docs)

  • Renamed and moved Why Wing to What is Wing? to the top of the learn section.

  • Moved and added new subfolders to Platforms to under core concepts.

  • Renamed and added new sections for Libraries, renamed to Wing Libraries (winglibs)

    • Split previous page into three new pages.
      • What are winglibs?
      • Importing winglibs
      • Creating winglibs
  • Tools, Guides, TypeScript and FAQ sections untouched (apart from CLI guide moving from tools)

Other notes

  • Added redirects for pages to their new urls.

TODO

  • Add redirects for Standard Library
  • Replace urls in the docssite for anything that has moved (don't force folks to redirect unless we miss something).
  • Make changes into the main docs repo once this PR has been reviewed and the direction of docs has been approved.
  • Update webflow for winglang.io with nav changes.

Copy link

vercel bot commented Jul 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
wing-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 8, 2024 3:00pm

@boyney123 boyney123 marked this pull request as draft July 2, 2024 15:02
@boyney123
Copy link
Contributor Author

Happy to split this into smaller Pull request if it makes it easier to review.

Also I found this reverse proxy https://github.com/winglang/website-proxy?tab=readme-ov-file#behaviors

I need to make changes here for /api route before this can be merged.

@boyney123 boyney123 closed this Jul 8, 2024
@mergify mergify bot merged commit 1971713 into main Jul 8, 2024
6 of 7 checks passed
mergify bot pushed a commit to winglang/wing that referenced this pull request Jul 8, 2024
… v2 (#6864)

These are required changes for the docs site winglang/docsite#951

These can only be merged once winglang/docsite#951 has been merged.

## Checklist

- [x ] Title matches [Winglang's style guide](https://www.winglang.io/contributing/start-here/pull_requests#how-are-pull-request-titles-formatted)
- [x ] Description explains motivation and solution
- [ ] Tests added (always)
- [ ] Docs updated (only required for features)
- [ ] Added `pr/e2e-full` label if this feature requires end-to-end testing

*By submitting this pull request, I confirm that my contribution is made under the terms of the [Wing Cloud Contribution License](https://github.com/winglang/wing/blob/main/CONTRIBUTION_LICENSE.md)*.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

New API section in the docs
2 participants