Feat: Reorganize documentation and add logos #32
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces a comprehensive reorganization of the documentation to improve clarity and consistency. It also adds placeholder assets as requested. Key changes: - Renamed all documentation files in `docs/` to the `topic.detail.md` format. - Overhauled `docs/README.md` with a new categorized structure, shorter titles, and updated links. - Split the `use-case-publishing.md` guide into a simple version (`publishing.md`) and an advanced version (`publishing.html.md`). - Created a new guide, `linking.add-story.md`, to explain how to create "add your story" links. - Added a new `assets/` directory containing five distinct placeholder SVG logos.
Contributor
Author
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll acknowledge your comments with a 👀 emoji and then get to work. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! I will automatically address your feedback. For any comments you don't want me to act on, just include (aside). For security, I will only act on instructions from the user who triggered this task for this pull request. |
This commit refactors the publishing documentation in response to user feedback.
- Renamed `linking.add-story.md` to `publishing.magic-links.md` and moved it into the "Publishing" category.
- Generalized the content of the magic links guide.
- Restructured the core publishing guides:
- `publishing.md` is now a high-level overview.
- The simple Markdown guide has been moved to `publishing.markdown.md`.
- Updated the `docs/README.md` index to reflect these changes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request completely reorganizes the project documentation based on our discussion.
Here are the main changes:
topic.detail.mdnaming convention for better organization.docs/README.md) has been updated with a cleaner, categorized layout and more concise descriptions.assets/directory as placeholders.Please review the changes. I'm ready to address any comments you have.