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

Information architecture work #165

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

kalisjoshua
Copy link
Contributor

@kalisjoshua kalisjoshua commented Jan 13, 2025

  1. Move the content of the docs site to apps/docs/content instead of apps/docs/docs - because reasons
  2. Fix links to CONTRIBUTING and LICENSE in published pages
  3. Make the landing page of the docs site be the README brought in from the root through TypeDoc
  4. Update the root README content to align with the future state of having a published docs site
  5. Changed the output directory of TypeDoc to be api to match the top-bar (Docusaurus) nav item and url structure

@kalisjoshua kalisjoshua marked this pull request as draft January 13, 2025 20:39
Copy link
Contributor

@belsrc belsrc left a comment

Choose a reason for hiding this comment

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

One tiny comment but looks fine otherwise.


import { MarkdownPageEvent } from 'typedoc-plugin-markdown';

export function load(app) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a what/why comment to this? See that it is prefixing some text to the content but have no idea why it is necessary.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. :)

@kalisjoshua kalisjoshua force-pushed the kalis-1/integration/docs-site branch 6 times, most recently from 3b4207c to eb72007 Compare January 14, 2025 17:11
@kalisjoshua kalisjoshua marked this pull request as ready for review January 14, 2025 18:24
@kalisjoshua kalisjoshua force-pushed the kalis-1/integration/docs-site branch from eb72007 to d6f909b Compare January 14, 2025 18:31
@kalisjoshua kalisjoshua force-pushed the kalis-1/integration/docs-site branch from d6f909b to 4c51e20 Compare January 14, 2025 18:31
Copy link
Contributor

@orteth01 orteth01 left a comment

Choose a reason for hiding this comment

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

noice


- There are three Docusaurus groupings that can house content: pages (can NOT have a sidebar), docs, and blog. We will primarily use docs as our content organization grouping strategy in Docusaurus.
- Pages (src/pages)
- Highest priority for resolution it seems because with a default page in `content/README.md`
Copy link
Contributor

Choose a reason for hiding this comment

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

incomplete sentence?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep. Will have to complete the thought.

@kalisjoshua kalisjoshua merged commit 5bc986e into integration/docs-site Jan 14, 2025
3 checks passed
@kalisjoshua kalisjoshua deleted the kalis-1/integration/docs-site branch January 14, 2025 18:36
kalisjoshua added a commit that referenced this pull request Jan 14, 2025
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.

3 participants