Skip to content

docs: Manual Installation section & Restructured pages#285

Closed
TechAkayy wants to merge 3 commits intomainfrom
docs-update
Closed

docs: Manual Installation section & Restructured pages#285
TechAkayy wants to merge 3 commits intomainfrom
docs-update

Conversation

@TechAkayy
Copy link
Collaborator

@TechAkayy TechAkayy commented Jan 17, 2025

This PR covers:

  1. Minor updates to the docs.
  2. Manual installation section in the Getting Started page
    • To help new users who want to use Iles in their existing projects.
    • Used npm for the commands as it comes default with nodejs, and have also been used in other pages too. Sticking with npm commands will be easy especially for new users and ensures consistency. So does vue, nuxt, vite, vitepress, astro docs.
  3. Restructuring the docs pages with the following changes:
    • Renaming "Routing" to "Pages"
    • Renaming "Development" to "Project Structure"
    • Reorder - Pages, then Markdown, then Documents.

@ElMassimo, I have pushed each of the above as separate commits, feel free to de-scope the restructing of the pages if you want to keep the structure as-is.

image

@nx-cloud
Copy link

nx-cloud bot commented Jan 17, 2025

View your CI Pipeline Execution ↗ for commit f6962c1.

Command Status Duration Result
nx run-many --target=build --all --exclude docs... ✅ Succeeded 1s View ↗
nx run-many --target=lint --all ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2025-01-17 11:14:15 UTC

@TechAkayy TechAkayy changed the title Minor updates with tips Jan 17, 2025
@TechAkayy TechAkayy changed the title Docs update - Manual Installation section & Restructured pages Jan 22, 2025
@TechAkayy
Copy link
Collaborator Author

I will be following up with futher PRs (fixes and feature) where I will be addressing some complexities in the this getting-started update. Specifically, simplify workflow by:

  • Making site.ts & app.ts optional, so that user just have to do npm add -D iles and run npx iles build, similar to Vitepress.
@TechAkayy
Copy link
Collaborator Author

Superseded by new set of PRs covering a range of docs update

@TechAkayy TechAkayy closed this Jan 28, 2025
@TechAkayy TechAkayy deleted the docs-update branch January 28, 2025 02:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant