Skip to content

Add documentation for Quick Start Project #126

Merged
abose merged 6 commits intophcode-dev:mainfrom
devvaannsh:main
Oct 5, 2024
Merged

Add documentation for Quick Start Project #126
abose merged 6 commits intophcode-dev:mainfrom
devvaannsh:main

Conversation

@devvaannsh
Copy link
Copy Markdown
Member

This PR does the following changes :-

  1. Adds documentation for Quick Start Project, along with the images. (This appears as a separate section in between 'Editing-Text' and 'Features'.
  2. It sets the trailingSlash to false in docusaurus.config.js, as it was adding unnecessary slashes at the end of the file paths. This was causing issues when trying to provide the file path without the extension.
    For ex :- 'features/quickEdit' (is valid path), but because of the trailingSlash the file path became :-
    'features/quickEdit/' (invalid path)
  3. Modified the way the filepaths are provided, now indexes of files are no longer needed. Thus, won't need to modify the file paths, whenever a new section is added/removed.
    (04-Features/06-quick-edit.md) [previously]
    (Features/quick-edit) [current]

Comment thread docusaurus.config.js
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",
trailingSlash: true,
trailingSlash: false,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Will this break links in the existing userbase? Eg: we have doc links with a / distributed in desktop apps, and those links may end up unreachable?
https://github.com/phcode-dev/phoenix/blob/main/src/assets/default-project/en/Newly_added_features.md?plain=1

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes, you're right. This change might break those links.

@abose abose merged commit a8025cb into phcode-dev:main Oct 5, 2024
@abose
Copy link
Copy Markdown
Member

abose commented Oct 5, 2024

LGTM. Thanks for contributing @devvaannsh

Merging to test.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants